1.0.5 • Published 5 months ago

@shtrikh17/spectre v1.0.5

Weekly downloads
-
License
-
Repository
-
Last release
5 months ago

Spectre

Simple plate editor for customized text rendering.

This project will contain implementations of various reactive editors based on shadcn/ui and shadcn-ex. For now I have included only basic editor based on plate. In future other editors might be added as well.

Following sub-projects are included in this repository: 1. spectre: This is the main project which contains the installation component. 2. templates: This project contains the templates for the installation component and corresponding storybook.

Note: storybook is not ready yet as the project's been copied from shadcn-ex

WARNING: installation script does not fix dependencies path of shadcn and shadcn-ex for now. To be fixed later on.

Demo

Demo coming soon

Installation

The library works almost the same way as shadcn. The only difference is in the usage of registry. Our library is tiny and it brings all the code required with it. Note: in comparison with shadcn-ex installation is performed directory-wide, i.e. you get all components associated with chosen editor (as almost all files are necessary both for editor and viewer).

npm install @shtrikh17/spectr
npx @shtrikh17/spectr add <EditorName>

That's it. Now you can edit the components the way you want. The components are located in the components/spectre directory (near original ui directory).

Components

NameDescription
SpectreBasicA simple editor based on plate & shadcn and intended for usage both as standalone or collaborative editor (collaboration server example will be posted soon).