BlockSuite API Documentation / @blocksuite/blocks / ListBlockComponent

Class: ListBlockComponent

Extends

• CaptionedBlockComponent<ListBlockModel, ListBlockService>

Constructors

new ListBlockComponent()

new ListBlockComponent(): ListBlockComponent

Returns

ListBlockComponent

Inherited from

CaptionedBlockComponent<ListBlockModel, ListBlockService>.constructor

Defined in

packages/affine/components/dist/caption/captioned-block-component.d.ts:14

Other

_disposables

protected _disposables: DisposableGroup

Inherited from

CaptionedBlockComponent._disposables

Defined in

packages/framework/global/dist/utils/with-disposable.d.ts:5

---

[blockComponentSymbol]

[blockComponentSymbol]: boolean

Inherited from

CaptionedBlockComponent.[blockComponentSymbol]

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:14

---

disposables

readonly disposables: DisposableGroup

Inherited from

CaptionedBlockComponent.disposables

Defined in

packages/framework/global/dist/utils/with-disposable.d.ts:6

---

handleEvent()

handleEvent: (name, handler, options?) => void

Parameters

• name: "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "beforeInput" | "blur" | "focus" | "contextMenu" | "wheel"

• handler: UIEventHandler

• options?

• options.flavour?: boolean

• options.global?: boolean

Returns

void

Inherited from

CaptionedBlockComponent.handleEvent

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:15

---

virtualKeyboardPolicy

virtualKeyboardPolicy: string

Inherited from

CaptionedBlockComponent.virtualKeyboardPolicy

Defined in

packages/framework/global/dist/types/virtual-keyboard.d.ts:20

---

disableShadowRoot

static disableShadowRoot: boolean

Inherited from

CaptionedBlockComponent.disableShadowRoot

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:4

---

styles

static styles: CSSResult

Overrides

CaptionedBlockComponent.styles

Defined in

packages/affine/block-list/dist/list-block.d.ts:8

---

_renderers

Inherited from

CaptionedBlockComponent._renderers

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:53

---

attributeRenderer

get attributeRenderer(): AttributeRenderer<AffineTextAttributes>

Returns

AttributeRenderer<AffineTextAttributes>

Defined in

packages/affine/block-list/dist/list-block.d.ts:11

---

attributesSchema

get attributesSchema(): ZodObject<Record<keyof AffineTextAttributes, ZodTypeAny>, UnknownKeysParam, ZodTypeAny, object, object>

Returns

ZodObject<Record<keyof AffineTextAttributes, ZodTypeAny>, UnknownKeysParam, ZodTypeAny, object, object>

Defined in

packages/affine/block-list/dist/list-block.d.ts:12

---

blockContainerStyles

Overrides

CaptionedBlockComponent.blockContainerStyles

Defined in

packages/affine/block-list/dist/list-block.d.ts:47

---

blockId

get blockId(): string

Returns

string

Inherited from

CaptionedBlockComponent.blockId

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:19

---

captionEditor

get captionEditor(): undefined | BlockCaptionEditor<BlockModel<BlockCaptionProps, BlockCaptionProps & object>>

Returns

undefined | BlockCaptionEditor<BlockModel<BlockCaptionProps, BlockCaptionProps & object>>

Inherited from

CaptionedBlockComponent.captionEditor

Defined in

packages/affine/components/dist/caption/captioned-block-component.d.ts:11

---

childBlocks

get childBlocks(): BlockComponent<BlockModel<object, object>, BlockService, string>[]

Returns

BlockComponent<BlockModel<object, object>, BlockService, string>[]

Inherited from

CaptionedBlockComponent.childBlocks

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:20

---

doc

Inherited from

CaptionedBlockComponent.doc

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:55

---

embedChecker

get embedChecker(): (delta) => boolean

Returns

Function

Parameters

• delta: DeltaInsert<AffineTextAttributes>

Returns

boolean

Defined in

packages/affine/block-list/dist/list-block.d.ts:35

---

flavour

get flavour(): string

Returns

string

Inherited from

CaptionedBlockComponent.flavour

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:21

---

host

get host(): EditorHost

Returns

EditorHost

Inherited from

CaptionedBlockComponent.host

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:22

---

inlineManager

get inlineManager(): InlineManager

Returns

InlineManager

Defined in

packages/affine/block-list/dist/list-block.d.ts:36

---

isVersionMismatch

get isVersionMismatch(): boolean

Returns

boolean

Inherited from

CaptionedBlockComponent.isVersionMismatch

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:23

---

markdownShortcutHandler

get markdownShortcutHandler(): (context, undoManager) => boolean

Returns

Function

Parameters

• context: KeyboardBindingContext<AffineTextAttributes>

• undoManager: UndoManager

Returns

boolean

Defined in

packages/affine/block-list/dist/list-block.d.ts:37

---

model

get model(): Model

Returns

Model

Inherited from

CaptionedBlockComponent.model

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:24

---

parentComponent

get parentComponent(): null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Returns

null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Inherited from

CaptionedBlockComponent.parentComponent

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:25

---

renderChildren

get renderChildren(): (model, filter?) => TemplateResult

Returns

Function

Parameters

• model: BlockModel<object, SignaledProps<object>>

• filter?

Returns

TemplateResult

Inherited from

CaptionedBlockComponent.renderChildren

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:26

---

rootComponent

get rootComponent(): null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Returns

null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Inherited from

CaptionedBlockComponent.rootComponent

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:27

---

selected

get selected(): null | BaseSelection

Returns

null | BaseSelection

Inherited from

CaptionedBlockComponent.selected

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:28

---

selectedStyle

Inherited from

CaptionedBlockComponent.selectedStyle

Defined in

packages/affine/components/dist/caption/captioned-block-component.d.ts:18

---

selection

get selection(): SelectionManager

Returns

SelectionManager

Inherited from

CaptionedBlockComponent.selection

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:29

---

service

get service(): Service

Returns

Service

Inherited from

CaptionedBlockComponent.service

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:30

---

std

Inherited from

CaptionedBlockComponent.std

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:12

---

topContenteditableElement

get topContenteditableElement(): null | BlockComponent<BlockModel<object, object>, BlockService, string>

Returns

null | BlockComponent<BlockModel<object, object>, BlockService, string>

Overrides

CaptionedBlockComponent.topContenteditableElement

Defined in

packages/affine/block-list/dist/list-block.d.ts:38

---

useCaptionEditor

Inherited from

CaptionedBlockComponent.useCaptionEditor

Defined in

packages/affine/components/dist/caption/captioned-block-component.d.ts:19

---

useZeroWidth

Inherited from

CaptionedBlockComponent.useZeroWidth

Defined in

packages/affine/components/dist/caption/captioned-block-component.d.ts:20

---

viewType

Inherited from

CaptionedBlockComponent.viewType

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:56

---

widgetComponents

get widgetComponents(): Partial<Record<WidgetName, WidgetComponent<BlockModel<object, SignaledProps<object>>, BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>, BlockService>>>

Returns

Partial<Record<WidgetName, WidgetComponent<BlockModel<object, SignaledProps<object>>, BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>, BlockService>>>

Inherited from

CaptionedBlockComponent.widgetComponents

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:32

---

widgets

Inherited from

CaptionedBlockComponent.widgets

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:57

---

addRenderer()

addRenderer(renderer): void

Parameters

• renderer

Returns

void

Inherited from

CaptionedBlockComponent.addRenderer

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:35

---

bindHotKey()

bindHotKey(keymap, options?): () => void

Parameters

• keymap: Record<string, UIEventHandler>

• options?

• options.flavour?: boolean

• options.global?: boolean

Returns

Function

Returns

void

Inherited from

CaptionedBlockComponent.bindHotKey

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:36

---

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

CaptionedBlockComponent.connectedCallback

Defined in

packages/affine/block-list/dist/list-block.d.ts:42

---

getUpdateComplete()

getUpdateComplete(): Promise<boolean>

Returns

Promise<boolean>

Overrides

CaptionedBlockComponent.getUpdateComplete

Defined in

packages/affine/block-list/dist/list-block.d.ts:43

---

renderBlock()

renderBlock(): TemplateResult<1>

Returns

TemplateResult<1>

Overrides

CaptionedBlockComponent.renderBlock

Defined in

packages/affine/block-list/dist/list-block.d.ts:44

---

renderVersionMismatch()

renderVersionMismatch(expectedVersion, actualVersion): TemplateResult

Render a warning message when the block version is mismatched.

Parameters

• expectedVersion: number

If the schema is not found, the expected version is -1. Which means the block is not supported in the current editor.

• actualVersion: number

The version of the block's crdt data.

Returns

TemplateResult

Inherited from

CaptionedBlockComponent.renderVersionMismatch

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:51

lifecycle

disconnectedCallback()

disconnectedCallback(): void

Invoked when the component is removed from the document's DOM.

This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

disconnectedCallback() {
  super.disconnectedCallback();
  window.removeEventListener('keydown', this._handleKeydown);
}

An element may be re-connected after being disconnected.

Returns

void

Inherited from

CaptionedBlockComponent.disconnectedCallback

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:41

rendering

createRenderRoot()

createRenderRoot(): HTMLElement | DocumentFragment

Returns

HTMLElement | DocumentFragment

Inherited from

CaptionedBlockComponent.createRenderRoot

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:6

---

render()

render(): unknown

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns

unknown

Inherited from

CaptionedBlockComponent.render

Defined in

packages/framework/block-std/dist/view/element/block-component.d.ts:43

styles

finalizeStyles()

protected static finalizeStyles(styles?): CSSResultOrNative[]

Takes the styles the user supplied via the static styles property and returns the array of styles to apply to the element. Override this method to integrate into a style management system.

Styles are deduplicated preserving the last instance in the list. This is a performance optimization to avoid duplicated styles that can occur especially when composing via subclassing. The last item is kept to try to preserve the cascade order with the assumption that it's most important that last added styles override previous styles.

Parameters

• styles?: CSSResultGroup

Returns

CSSResultOrNative[]

Nocollapse

Inherited from

CaptionedBlockComponent.finalizeStyles

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:5