mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-08-30 18:39:51 +02:00
update plugins doc
This commit is contained in:
Ian Storm Taylor
@@ -8,60 +8,60 @@ Here's a list of Slate plugins, organized by category, so that they're easier to
|
||||
|
||||
Plugins that add specific behaviors to your editor.
|
||||
|
||||
|**Plugin**|**Downloads**|**Description**|
|
||||
|**Plugin**|**Description**|**Downloads**|
|
||||
|---|---|---|
|
||||
|[`slate-auto-replace`](https://yarnpkg.com/en/package/slate-auto-replace)||Automatically transform certain input as a user types.|
|
||||
|[`slate-collapse-on-escape`](https://yarnpkg.com/en/package/slate-collapse-on-escape)||Collapse the selection when users hit <kbd>esc</kbd>.|
|
||||
|[`slate-drop-or-paste-images`](https://yarnpkg.com/en/package/slate-drop-or-paste-images)||Allows users to insert images by drag-dropping or copy-pasting.|
|
||||
|[`slate-edit-blockquote`](https://yarnpkg.com/en/package/slate-edit-blockquote)||Adds blockquote editing behaviors to an editor.|
|
||||
|[`slate-edit-code`](https://yarnpkg.com/en/package/slate-edit-code)||Adds code block editing behaviors to an editor.|
|
||||
|[`slate-edit-footnote`](https://yarnpkg.com/en/package/slate-edit-footnote)||Adds footnote editing behaviors to an editor.|
|
||||
|[`slate-edit-list`](https://yarnpkg.com/en/package/slate-edit-list)||Adds list editing behaviors to an editor.|
|
||||
|[`slate-edit-table`](https://yarnpkg.com/en/package/slate-edit-table)||Adds common table editing behaviors to an editor.|
|
||||
|[`slate-mentions`](https://yarnpkg.com/en/package/slate-mentions)||Adds mentions like Facebook's to an editor.|
|
||||
|[`slate-no-empty`](https://yarnpkg.com/en/package/slate-no-empty)||Prevents documents from being empty.|
|
||||
|[`slate-paste-linkify`](https://yarnpkg.com/en/package/slate-paste-linkify)||Automatically linkify URLs when they are pasted.|
|
||||
|[`slate-soft-break`](https://yarnpkg.com/en/package/slate-soft-break)||Adds soft breaks when users hit <kbd>enter</kbd>.|
|
||||
|[`slate-sticky-inlines`](https://yarnpkg.com/en/package/slate-sticky-inlines)||Changes the inline node behavior to allow editing at the edges.|
|
||||
|[`slate-suggestions`](https://yarnpkg.com/en/package/slate-suggestions)||Displays inline auto-completed suggestions.|
|
||||
|[`slate-trailing-block`](https://yarnpkg.com/en/package/slate-trailing-block)||Ensure that documents end in a specific kind of block.|
|
||||
|[`slate-auto-replace`](https://yarnpkg.com/en/package/slate-auto-replace)|Automatically transform certain input as a user types.||
|
||||
|[`slate-collapse-on-escape`](https://yarnpkg.com/en/package/slate-collapse-on-escape)|Collapse the selection when users hit <kbd>esc</kbd>.||
|
||||
|[`slate-drop-or-paste-images`](https://yarnpkg.com/en/package/slate-drop-or-paste-images)|Allows users to insert images by drag-dropping or copy-pasting.||
|
||||
|[`slate-edit-blockquote`](https://yarnpkg.com/en/package/slate-edit-blockquote)|Adds blockquote editing behaviors to an editor.||
|
||||
|[`slate-edit-code`](https://yarnpkg.com/en/package/slate-edit-code)|Adds code block editing behaviors to an editor.||
|
||||
|[`slate-edit-footnote`](https://yarnpkg.com/en/package/slate-edit-footnote)|Adds footnote editing behaviors to an editor.||
|
||||
|[`slate-edit-list`](https://yarnpkg.com/en/package/slate-edit-list)|Adds list editing behaviors to an editor.||
|
||||
|[`slate-edit-table`](https://yarnpkg.com/en/package/slate-edit-table)|Adds common table editing behaviors to an editor.||
|
||||
|[`slate-mentions`](https://yarnpkg.com/en/package/slate-mentions)|Adds mentions like Facebook's to an editor.||
|
||||
|[`slate-no-empty`](https://yarnpkg.com/en/package/slate-no-empty)|Prevents documents from being empty.||
|
||||
|[`slate-paste-linkify`](https://yarnpkg.com/en/package/slate-paste-linkify)|Automatically linkify URLs when they are pasted.||
|
||||
|[`slate-soft-break`](https://yarnpkg.com/en/package/slate-soft-break)|Adds soft breaks when users hit <kbd>enter</kbd>.||
|
||||
|[`slate-sticky-inlines`](https://yarnpkg.com/en/package/slate-sticky-inlines)|Changes the inline node behavior to allow editing at the edges.||
|
||||
|[`slate-suggestions`](https://yarnpkg.com/en/package/slate-suggestions)|Displays inline auto-completed suggestions.||
|
||||
|[`slate-trailing-block`](https://yarnpkg.com/en/package/slate-trailing-block)|Ensure that documents end in a specific kind of block.||
|
||||
|
||||
|
||||
### Components
|
||||
|
||||
Components for building Slate editors.
|
||||
|
||||
|**Plugin**|**Downloads**|**Description**|
|
||||
|**Plugin**|**Description**|**Downloads**|
|
||||
|---|---|---|
|
||||
|[`slate-editor-icons`](https://yarnpkg.com/en/package/slate-editor-icons)||A set of icons for using in toolbars, etc.|
|
||||
|[`slate-editor-icons`](https://yarnpkg.com/en/package/slate-editor-icons)|A set of icons for using in toolbars, etc.||
|
||||
|
||||
|
||||
### Serializers
|
||||
|
||||
Serializers for handling Slate data.
|
||||
|
||||
|**Plugin**|**Downloads**|**Description**|
|
||||
|**Plugin**|**Description**|**Downloads**|
|
||||
|---|---|---|
|
||||
|[`slate-base64-serializer`](https://yarnpkg.com/en/package/slate-base64-serializer)||A base64 string serializer for Slate documents.|
|
||||
|[`slate-html-serializer`](https://yarnpkg.com/en/package/slate-html-serializer)||An HTML serializer for Slate documents.|
|
||||
|[`slate-plain-serializer`](https://yarnpkg.com/en/package/slate-plain-serializer)||A plain text serializer for Slate documents.|
|
||||
|[`slate-base64-serializer`](https://yarnpkg.com/en/package/slate-base64-serializer)|A base64 string serializer for Slate documents.||
|
||||
|[`slate-html-serializer`](https://yarnpkg.com/en/package/slate-html-serializer)|An HTML serializer for Slate documents.||
|
||||
|[`slate-plain-serializer`](https://yarnpkg.com/en/package/slate-plain-serializer)|A plain text serializer for Slate documents.||
|
||||
|
||||
|
||||
### Utils
|
||||
|
||||
Useful utilities when working with Slate documents and components.
|
||||
|
||||
|**Plugin**|**Downloads**|**Description**|
|
||||
|**Plugin**|**Description**|**Downloads**|
|
||||
|---|---|---|
|
||||
|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)||Prints Slate documents in their `slate-hyperscript` format.|
|
||||
|[`slate-hyperscript`](https://yarnpkg.com/en/package/slate-hyperscript)||Allows you to express Slate documents in JSX.|
|
||||
|[`slate-prop-types`](https://yarnpkg.com/en/package/slate-prop-types)||A set of prop types to use in your Slate components.|
|
||||
|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|Prints Slate documents in their `slate-hyperscript` format.||
|
||||
|[`slate-hyperscript`](https://yarnpkg.com/en/package/slate-hyperscript)|Allows you to express Slate documents in JSX.||
|
||||
|[`slate-prop-types`](https://yarnpkg.com/en/package/slate-prop-types)|A set of prop types to use in your Slate components.||
|
||||
|
||||
|
||||
### Editors
|
||||
|
||||
Full-feature editors for Slate, in case you need a drop-in one.
|
||||
|
||||
|**Plugin**|**Downloads**|**Description**|
|
||||
|**Plugin**|**Description**|**Downloads**|
|
||||
|---|---|---|
|
||||
|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)||Prints Slate documents in their `slate-hyperscript` format.|
|
||||
|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|Prints Slate documents in their `slate-hyperscript` format.||
|
||||
|
||||
Reference in New Issue
Block a user