Skip to content

@sqlrooms/documents / BlockDocumentStatefulBlockType

Type Alias: BlockDocumentStatefulBlockType ​

BlockDocumentStatefulBlockType = object

Properties ​

blockType ​

blockType: string


label? ​

optional label?: string


description? ​

optional description?: string


resizableHeight? ​

optional resizableHeight?: boolean


defaultHeight? ​

optional defaultHeight?: number


minHeight? ​

optional minHeight?: number


maxHeight? ​

optional maxHeight?: number


requireScrollModifier? ​

optional requireScrollModifier?: boolean


scrollHintLabel? ​

optional scrollHintLabel?: string


settings? ​

optional settings?: BlockSettingsComponent


hasOwnHeaderActions? ​

optional hasOwnHeaderActions?: boolean

True when the renderer places host header actions in its own header.


createNode? ​

optional createNode?: (blockId, options?) => Record<string, unknown>

Parameters ​

ParameterType
blockIdstring
options?BlockDocumentStatefulBlockCreateNodeOptions

Returns ​

Record<string, unknown>