1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-09 08:46:35 +02:00

remove renderPortal from the docs, prepping for removal

This commit is contained in:
Ian Storm Taylor
2017-03-03 13:15:04 -08:00
parent 1d8aa81460
commit 5d285164b6

View File

@@ -21,7 +21,6 @@ When the editor needs to resolve a plugin-related handler, it will loop through
- [`onChange`](#onchange) - [`onChange`](#onchange)
- [`onBeforeChange`](#onbeforechange) - [`onBeforeChange`](#onbeforechange)
- [`render`](#render) - [`render`](#render)
- [`renderPortal`](#renderportal)
- [`schema`](#schema) - [`schema`](#schema)
@@ -223,11 +222,6 @@ Like `onChange`, `onBeforeChange` is cummulative.
The `render` property allows you to define higher-order-component-like behavior. It is passed all of the properties of the editor, including `props.children`. You can then choose to wrap the existing `children` in any custom elements or proxy the properties however you choose. This can be useful for rendering toolbars, styling the editor, rendering validation, etc. The `render` property allows you to define higher-order-component-like behavior. It is passed all of the properties of the editor, including `props.children`. You can then choose to wrap the existing `children` in any custom elements or proxy the properties however you choose. This can be useful for rendering toolbars, styling the editor, rendering validation, etc.
### `renderPortal`
`Function renderPortal(state: State, editor: Editor) => Object || Void`
The `renderPortal` property allows you to define extra elements that will render outside of the editor, in a separate [portal](). This is useful for rendering hovering menus, or other cases where you don't need to render inside the editor, but want to add elements to the DOM.
### `schema` ### `schema`
`Object` `Object`