Skip to content
Portable Text

defineTextBlock

defineTextBlock(config): TextBlock

Defined in: packages/editor/src/renderers/renderer.types.ts:270

Define a text block renderer. The returned registration is mounted via the <TextBlockPlugin> wrapper.

Only one text block registration is supported today. Subsequent registrations log a console warning and skip.

Parameters

Section titled “Parameters”

config

Section titled “config”

render

Section titled “render”

TextBlockRender

type

Section titled “type”

"block"

Returns

Section titled “Returns”

TextBlock

Example

Section titled “Example”
defineTextBlock({
  type: 'block',
  render: ({attributes, children}) => (
    // (p {...attributes})({children})(/p)
  ),
})