mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-02-22 08:02:25 +01:00
f1b7d18f43
* Official custom inlines example This generalizes the "links" example to an "inlines" example, adding a new example of an inline: an "editable button". Firstly, this is important to demonstrate that Slate really does allow _custom_ elements, and not just "standard" ones like links that you'll find in any editor. Secondly, it's important to show an example of an inline where "offset" movement should be used. With links, it's arguable that the cursor positions <link>foo<cursor/></link> and <link>foo</link><cursor/> should be considered the same, because they display in the same position. But with the editable button, the cursor is clearly in a different position, and so offset movement should be used. * lint * fix integration test * update readme * try again
1.9 KiB
1.9 KiB
Examples
This directory contains a set of examples that give you an idea for how you might use Slate to implement your own editor. Take a look around!
- Plain text — showing the most basic case: a glorified
<textarea>. - Rich text — showing the features you'd expect from a basic editor.
- Forced Layout - showing how to use constraints to enforce a document structure.
- Markdown Shortcuts — showing how to add key handlers for Markdown-like shortcuts.
- Inlines — showing how wrap text in inline nodes with associated data.
- Images — showing how to use void (text-less) nodes to add images.
- Hovering toolbar — showing how a hovering toolbar can be implemented.
- Tables — showing how to nest blocks to render more advanced components.
- Paste HTML — showing how to use an HTML serializer to handle pasted HTML.
- Code Highlighting — showing how to use decorations to dynamically format text.
- ...and more!
If you have an idea for an example that shows a common use case, pull request it!
Running the Examples
To get the examples running on your machine, you need to have the Slate repository cloned to your computer. After that, you need to cd into the directory where you cloned it, and install the dependencies with yarn and build the monorepo:
yarn install
yarn build
Then start the watcher and examples server:
yarn start
Now you can open up http://localhost:3000 in your browser and you'll see the examples site. Any changes you make to the source code will be immediately reflected when you refresh the page. You can open the examples URL quickly with:
yarn open