Skip to content

BlockSuite API Documentation / @blocksuite/blocks / ListService

Class: ListService<TextAttributes>

Extends

Type parameters

TextAttributes extends AffineTextAttributes = AffineTextAttributes

Constructors

new ListService(options)

new ListService<TextAttributes>(options): ListService<TextAttributes>

Parameters

options: BlockServiceOptions

Returns

ListService<TextAttributes>

Inherited from

BlockService.constructor

Source

packages/framework/block-std/dist/service/index.d.ts:16

Properties

disposables

readonly disposables: DisposableGroup

Inherited from

BlockService.disposables

Source

packages/framework/block-std/dist/service/index.d.ts:14


flavour

readonly flavour: string

Inherited from

BlockService.flavour

Source

packages/framework/block-std/dist/service/index.d.ts:13


inlineManager

readonly inlineManager: InlineManager<TextAttributes>

Source

packages/blocks/src/list-block/list-service.ts:17


referenceNodeConfig

readonly referenceNodeConfig: ReferenceNodeConfig

Source

packages/blocks/src/list-block/list-service.ts:18


specSlots

readonly specSlots: BlockSpecSlots

Inherited from

BlockService.specSlots

Source

packages/framework/block-std/dist/service/index.d.ts:15


std

readonly std: BlockStdScope

Inherited from

BlockService.std

Source

packages/framework/block-std/dist/service/index.d.ts:12


styles

readonly styles: object

icon()

icon: (model, showChildren, onClick) => null | TemplateResult<1> = ListIcon

Parameters

model: ListBlockModel

showChildren: boolean

onClick

Returns

null | TemplateResult<1>

prefix

prefix: CSSResult = listPrefix

toggle

toggle: CSSResult = toggleStyles

Source

packages/blocks/src/list-block/list-service.ts:19

Accessors

collection

get collection(): DocCollection

Returns

DocCollection

Source

packages/framework/block-std/dist/service/index.d.ts:17


doc

get doc(): Doc

Returns

Doc

Source

packages/framework/block-std/dist/service/index.d.ts:18


host

get host(): HTMLElement

Returns

HTMLElement

Source

packages/framework/block-std/dist/service/index.d.ts:19


selectionManager

get selectionManager(): SelectionManager

Returns

SelectionManager

Source

packages/framework/block-std/dist/service/index.d.ts:20


uiEventDispatcher

get uiEventDispatcher(): UIEventDispatcher

Returns

UIEventDispatcher

Source

packages/framework/block-std/dist/service/index.d.ts:21

Methods

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

keymap: Record<string, UIEventHandler>

options?

options.global?: boolean

Returns

void

Inherited from

BlockService.bindHotKey

Source

packages/framework/block-std/dist/service/index.d.ts:28


dispose()

dispose(): void

Returns

void

Inherited from

BlockService.dispose

Source

packages/framework/block-std/dist/service/index.d.ts:22


handleEvent()

handleEvent(name, fn, options?): void

Parameters

name: "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "beforeInput" | "blur" | "focus" | "drop" | "contextMenu" | "wheel"

fn: UIEventHandler

options?

options.global?: boolean

Returns

void

Inherited from

BlockService.handleEvent

Source

packages/framework/block-std/dist/service/index.d.ts:25


mounted()

mounted(): void

Returns

void

Overrides

BlockService.mounted

Source

packages/blocks/src/list-block/list-service.ts:25


unmounted()

unmounted(): void

Returns

void

Inherited from

BlockService.unmounted

Source

packages/framework/block-std/dist/service/index.d.ts:24