@sqlrooms/blocks / StatefulBlockDefinition

Type Alias: StatefulBlockDefinition<TRoomState>

StatefulBlockDefinition<TRoomState> = object

Type Parameters

Type Parameter	Default type
TRoomState	unknown

Properties

type

type: BlockType

---

label

label: string

---

defaultTitle?

optional defaultTitle?: string

---

icon?

optional icon?: ComponentType<{ className?: string; }>

---

capabilities?

optional capabilities?: BlockCapabilities

---

createInstance?

optional createInstance?: (context) => BlockInstance

Parameters

Parameter	Type
context	StatefulBlockContext<TRoomState>

Returns

BlockInstance

---

ensureState?

optional ensureState?: (context) => void

Parameters

Parameter	Type
context	StatefulBlockContext<TRoomState>

Returns

void

---

deleteState?

optional deleteState?: (context) => void

Parameters

Parameter	Type
context	StatefulBlockContext<TRoomState>

Returns

void

---

rename?

optional rename?: (context) => void

Parameters

Parameter	Type
context	StatefulBlockRenameContext<TRoomState>

Returns

void

---

close?

optional close?: (context) => void

Parameters

Parameter	Type
context	StatefulBlockContext<TRoomState>

Returns

void

---

render

render: ComponentType<StatefulBlockRenderProps<TRoomState>>

---

settings?

optional settings?: ComponentType<StatefulBlockSettingsProps<TRoomState>>