Next (#3093)

* remove some key usage from core, refactor Operations.apply * undeprecate some methods * convert more key usage to paths * update deprecations * convert selection commands to use all paths * refactor word boundary selection logic * convert many at-range commands to use paths * convert wrapBlock and wrapInline to not use keys * cleanup * remove chainability from editor * simplify commands, queries and middleware * convert deleteAtRange * remove key usage from schema, deprecate *ByKey methods * migrate *ByKey tests, remove index from *ByPath signatures * rename at-current-range tests * deprecate mode key usage, migrate more tests away from keys * deprecate range and point methods which rely on keys to work * refactor insertBlock, without fixing warnings * add pathRef/pointRef, fix insertBlock/Inline deprecations, work on insertFragment * refactor insertFragment * get rich-text example rendering * fix lint * refactor query files, fix more tests * remove unused queries, refactor others * deprecate splitDescendantsByPath * merge master * add typescript, convert slate, slate-hyperscript, slate-plain-serializer * add Point, Path, Range, Annotation tests * add Annotation, Change, Element, Fragment, Mark, Range, Selection, Value interfaces tests * add Operation and Text tests * add Node tests * get operations and normalization tests working for slate * get *AtPath command tests passing * rename *AtPath command tests * rename * get *AtPoint tests working * rename * rename * add value queries tests * add element, mark and path queries tests * convert most on-selection tests * convert on-selection commands * rename * get addMarks and delete commands working * rename * rename * rename * refactor value.positions(), work on delete tests * progress on delete tests * more delete work * finish delete tests * start converting to at-based commands * restructure query tests * restructure operations tests * more work converting to multi-purpose commands * lots of progress on converting to at-based commands * add unwrapNodes * remove setValue * more progress * refactor node commands to use consistent matching logic * cleanup, get non-fragment commands passing * remove annotations and isAtomic * rename surround/pluck to cover/uncover * add location concept, change at-path to from-path for iterables * refactor batches * add location-based queries * refactor hanging logic * more location query work * renaming * use getMatch more * add split to wrap/unwrap * flip levels/ancestors ordering * switch splitNodes to use levels * change split to always:false by default * fix tests * add more queries tests * fixing more delete logic * add more splitNodes tests * get rest of delete tests passing * fix location-based logic in some commands * cleanup * get previous packages tests passing again * add slate-history package * start slate-schema work * start of react working * rendering fixes * get rich and plain text examples working * get image example working with hooks and dropping * refactor onDrop to be internal * inline more event handlers * refactor lots of event-related logic * change rendering to use render props * delete unused stuff * cleanup dom utils * remove unused deps * remove unnecessary packages, add placeholder * remove slate-react-placeholder package * remove unused dep * remove unnecessary tests, fix readonly example * convert checklists example * switch to next from webpack * get link example working * convert more examples * preserve keys, memoized leafs/texts, fix node lookup * fix to always useLayoutEffect for ordering * fix annotations to be maps, memoize elements * remove Change interface * remove String interface * rename Node.entries to Node.nodes * remove unnecessary value queries * default to selection when iterating, cleanup * remove unused files * update scroll into view logic * fix undoing, remove constructor types * dont sync selection while composing * add workflows * remove unused deps * convert mentions example * tweaks * convert remaining examples * rename h to jsx, update schema * fix schema tests * fix slate-schema logic and tests * really fix slate-schema and forced-layout example * get start of insertFragment tests working * remove Fragment interface * remove debugger * get all non-skipped tests passing * cleanup deps * run prettier * configure eslint for typescript * more eslint fixes... * more passing * update some docs * fix examples * port windows undo hotkey change * fix deps, add basic firefox support * add event overriding, update walkthroughs * add commands, remove classes, cleanup examples * cleanup rollup config * update tests * rename queries tests * update other tests * update walkthroughs * cleanup interface exports * cleanup, change mark transforms to require location * undo mark transform change * more * fix tests * fix example * update walkthroughs * update docs * update docs * remove annotations * remove value, move selection and children to editor * add migrating doc * fix lint * fix tests * fix DOM types aliasing * add next export * update deps, fix prod build * fix prod build * update scripts * update docs and changelogs * update workflow and pull request template
2025-08-30 10:29:48 +02:00 · 2019-11-27 20:54:42 -05:00
parent 02b87d5968
commit 4ff6972096
2367 changed files with 45706 additions and 80698 deletions
--- a/docs/concepts/09-rendering.md
+++ b/docs/concepts/09-rendering.md
@@ -0,0 +1,102 @@
+# Rendering
+
+One of the best parts of Slate is that it's built with React, so it fits right into your existing application. It doesn't re-invent its own view layer that you have to learn. It tries to keep everything as React-y as possible.
+
+To that end, Slate gives you control over the rendering behavior of your custom elements and custom marks in your rich-text domain.
+
+You can define these behaviors by passing "render props" to the top-level `<Editable>` component.
+
+For example if you wanted to render custom element components, you'd pass in the `renderElement` prop:
+
+```jsx
+import { createEditor } from 'slate'
+import { Slate, Editable, withReact } from 'slate-react'
+
+const MyEditor = () => {
+  const editor = useMemo(() => withReact(createEditor()), [])
+  const renderElement = useCallback(({ attributes, children, element }) => {
+    switch (element.type) {
+      case 'quote':
+        return <blockquote {...attributes}>{children}</blockquote>
+      case 'link':
+        return (
+          <a {...attributes} href={element.url}>
+            {children}
+          </a>
+        )
+      default:
+        return <p {...attributes}>{children}</p>
+    }
+  }, [])
+
+  return (
+    <Slate editor={editor}>
+      <Editable renderElement={renderElement} />
+    </Slate>
+  )
+}
+```
+
+> 🤖 Be sure to mix in `props.attributes` and render `props.children` in your custom components! The attributes must be added to the top-level DOM element inside the component, as they are required for Slate's DOM helper functions to work. And the children are the actual text content of your document which Slate manages for you automatically.
+
+You don't have to use simple HTML elements, you can use your own custom React components too:
+
+```js
+const renderElement = useCallback(props => {
+  switch (props.element.type) {
+    case 'quote':
+      return <QuoteElement {...props} />
+    case 'link':
+      return <LinkElement {...props} />
+    default:
+      return <DefaultElement {...props} />
+  }
+}, [])
+```
+
+The same thing goes for a custom `renderMark` prop:
+
+```jsx
+const renderMark = useCallback(({ attributes, children, mark }) => {
+  switch (mark.type) {
+    case 'bold':
+      return <strong {...attributes}>{children}</strong>
+    case 'italic':
+      return <em {...attributes}>{children}</em>
+  }
+}, [])
+```
+
+> 🤖 Be aware though that marks aren't guaranteed to be "contiguous". Which means even though a **word** is bolded, it's not guaranteed to render as a single `<strong>` element. If some of its characters are also italic, it might be split up into multiple elements—one `<strong>wo</strong>` and one `<em><strong>rd</strong></em>`.
+
+## Toolbars, Menus, Overlays, and more!
+
+In addition to controlling the rendering of elements and marks inside Slate, you can also retrieve the current editor context from inside other components using the `useSlate` hook.
+
+That way other components can execute commands, query the editor state, or anything else.
+
+A common use case for this is rendering a toolbar with formatting buttons that are highlighted based on the current selection:
+
+```jsx
+const MyEditor = () => {
+  const editor = useMemo(() => withReact(createEditor()), [])
+  return (
+    <Slate editor={editor}>
+      <Toolbar />
+      <Editable />
+    </Slate>
+  )
+}
+
+const Toolbar = () => {
+  const editor = useSlate()
+  return (
+    <div>
+      <Button active={isBoldActive(editor)}>B</Button>
+      <Button active={isItalicActive(editor)}>B</Button>
+    </div>
+  )
+}
+```
+
+Because the `<Toolbar>` uses the `useSlate` hook to retrieve the context, it will will re-render whenever the editor changes, so that the active state of the buttons stays in sync.