BlockObjectRenderProps
BlockObjectRenderProps =
object
Defined in: packages/editor/src/renderers/renderer.types.ts:162
A block object’s render function. Receives a non-editable block-level
portable text object. children carries an engine-emitted void
spacer that the browser uses to anchor the caret next to the
element. Dropping children makes the caret unable to land on the
element.
Properties
Section titled “Properties”attributes
Section titled “attributes”attributes:
Record<string,unknown>
Defined in: packages/editor/src/renderers/renderer.types.ts:163
children
Section titled “children”children:
ReactElement
Defined in: packages/editor/src/renderers/renderer.types.ts:164
focused
Section titled “focused”focused:
boolean
Defined in: packages/editor/src/renderers/renderer.types.ts:165
node:
PortableTextObject
Defined in: packages/editor/src/renderers/renderer.types.ts:166
path:
Path
Defined in: packages/editor/src/renderers/renderer.types.ts:167
readOnly
Section titled “readOnly”readOnly:
boolean
Defined in: packages/editor/src/renderers/renderer.types.ts:168
renderDefault()
Section titled “renderDefault()”renderDefault: (
props) =>ReactElement
Defined in: packages/editor/src/renderers/renderer.types.ts:174
Render this position with the engine’s default wrapper. See ContainerRenderProps.renderDefault.
Parameters
Section titled “Parameters”BlockObjectRenderProps
Returns
Section titled “Returns”ReactElement
selected
Section titled “selected”selected:
boolean
Defined in: packages/editor/src/renderers/renderer.types.ts:169