mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-09-01 03:11:44 +02:00
Update examples in docs, editable voids example (#4925)
* Update examples in docs, editable voids example * Update typescript docs
This commit is contained in:
@@ -35,24 +35,25 @@ declare module 'slate' {
|
||||
|
||||
## Annotations in the Editor
|
||||
|
||||
Annotate `useState` w/ `<Descendant[]>` and the editor's initial value w/ your custom Element type.
|
||||
Annotate the editor's initial value w/ `Descendant[]`.
|
||||
|
||||
```tsx
|
||||
import React, { useMemo, useState } from 'react'
|
||||
import { createEditor, Descendant } from 'slate'
|
||||
import { Slate, Editable, withReact } from 'slate-react'
|
||||
|
||||
const initialValue: Descendant[] = [
|
||||
{
|
||||
type: 'paragraph',
|
||||
children: [{ text: 'A line of text in a paragraph.' }],
|
||||
},
|
||||
]
|
||||
|
||||
const App = () => {
|
||||
const initialValue: Descendant[] = [
|
||||
{
|
||||
type: 'paragraph',
|
||||
children: [{ text: 'A line of text in a paragraph.' }],
|
||||
},
|
||||
]
|
||||
const editor = useMemo(() => withReact(createEditor()), [])
|
||||
const [value, setValue] = useState<Descendant[]>(initialValue)
|
||||
|
||||
return (
|
||||
<Slate editor={editor} value={value} onChange={setValue}>
|
||||
<Slate editor={editor} value={initialValue}>
|
||||
<Editable />
|
||||
</Slate>
|
||||
)
|
||||
|
@@ -95,7 +95,6 @@ const initialValue = []
|
||||
|
||||
const App = () => {
|
||||
const [editor] = useState(() => withReact(createEditor()))
|
||||
const [value, setValue] = useState([])
|
||||
return (
|
||||
// Add the editable component inside the context.
|
||||
<Slate editor={editor} value={initialValue}>
|
||||
@@ -122,7 +121,6 @@ const initialValue = [
|
||||
|
||||
const App = () => {
|
||||
const [editor] = useState(() => withReact(createEditor())
|
||||
const [value, setValue] = useState()
|
||||
|
||||
return (
|
||||
<Slate editor={editor} value={initialValue}>
|
||||
|
@@ -73,7 +73,7 @@ const App = () => {
|
||||
}, [])
|
||||
|
||||
return (
|
||||
<Slate editor={editor} value={value}>
|
||||
<Slate editor={editor} value={initialValue}>
|
||||
<Editable
|
||||
renderElement={renderElement}
|
||||
onKeyDown={event => {
|
||||
|
@@ -9,14 +9,13 @@ import { Button, Icon, Toolbar } from '../components'
|
||||
import { EditableVoidElement } from './custom-types'
|
||||
|
||||
const EditableVoidsExample = () => {
|
||||
const [value, setValue] = useState<Descendant[]>(initialValue)
|
||||
const editor = useMemo(
|
||||
() => withEditableVoids(withHistory(withReact(createEditor()))),
|
||||
[]
|
||||
)
|
||||
|
||||
return (
|
||||
<Slate editor={editor} value={value} onChange={setValue}>
|
||||
<Slate editor={editor} value={initialValue}>
|
||||
<Toolbar>
|
||||
<InsertEditableVoidButton />
|
||||
</Toolbar>
|
||||
|
Reference in New Issue
Block a user