slate.md

Table of Contents

• Plugin
  • name
  • schema
  • plugins
  • serialize
  • deserialize
  • onKeyDown
  • hoverButtons
  • toolbarButtons
  • renderMark
  • renderNode

Plugin

packages/plugins/content/slate/src/plugins/Plugin.js:30-95

name

packages/plugins/content/slate/src/plugins/Plugin.js:34-34

Type: string

schema

packages/plugins/content/slate/src/plugins/Plugin.js:39-42

Type: {nodes: {}?, marks: {}?}

plugins

packages/plugins/content/slate/src/plugins/Plugin.js:47-47

Type: Array<any>

serialize

packages/plugins/content/slate/src/plugins/Plugin.js:52-55

Type: function (object: {object: string, type: string, data: any}, children: Array<any>): any

deserialize

packages/plugins/content/slate/src/plugins/Plugin.js:60-60

Type: function (el: Element, next: Function): any

onKeyDown

packages/plugins/content/slate/src/plugins/Plugin.js:70-74

This handler is called when any key is pressed

Parameters

• e the keydown event
• data utilities for hotkey logic
• state the current editor state

Returns any the new editor state if the plugin handles the hotkey

hoverButtons

packages/plugins/content/slate/src/plugins/Plugin.js:79-79

Type: Array<Component<any, any, any>>

toolbarButtons

packages/plugins/content/slate/src/plugins/Plugin.js:84-84

Type: Array<Component<any, any, any>>

renderMark

packages/plugins/content/slate/src/plugins/Plugin.js:89-89

Type: Function

renderNode

packages/plugins/content/slate/src/plugins/Plugin.js:94-94

Type: Function