0.7.2 • Published 6 months ago
@quadrats/utils v0.7.2
Quadrats
A complete rich text editor.
Currently based on Slate framework.
Documentation
Features
| Elements | |
|---|---|
| Paragraph | Enables support for paragraphs. |
| Blockquote | Enables support for block quotes. |
| Embed | Enables support for embeddable media such as YouTube or Vimeo videos. |
| Divider | Enables support for dividers. |
| Heading | Enables support for headings (from 1 to 6). |
| Image | Enables support for images. |
| Link | Enables support for hyperlinks. |
| List | Enables support for bulleted, numbered lists. |
| ReadMore | Enables support for read more dividers. Commonly used in CMS. |
| Marks | |
|---|---|
| Bold | Enables support for bold formatting. |
| Highlight | Enables support for highlights. |
| Italic | Enables support for italic formatting. |
| Strikethrough | Enables support for strikethrough formatting. |
| Underline | Enables support for underline formatting. |
| Handlers | |
|---|---|
| Break | Enables support for inserting exit and soft breaks. |
| Widgets | |
|---|---|
| FileUploader | Enables support for uploading files. |
| InputBlock | Enables support for inputting processing. |
| Toolbar | Provides a toolbar with tools. |
| Serializers | |
|---|---|
| JsxSerializer | Provides serializer for rendering jsx. |
Development scripts
Useful scripts include:
yarnInstalls package dependencies
yarn buildBuild the local packages.
yarn storybook:startStarts storybook dev (after building).
yarn lintyarn testTest w/ jest.
yarn releaseUsing lerna to bump package versions, build and publish to npm via conventional changelog.