BlockSuite API Documentation / @blocksuite/blocks / LinkedWidgetConfig

Interface: LinkedWidgetConfig

Properties

convertTriggerKey

convertTriggerKey: boolean

Convert trigger key to primary key (the first item of the trigger keys) [[ -> @

Defined in

packages/blocks/src/root-block/widgets/linked-doc/config.ts:38

---

getMenus()

getMenus: (query, abort, editorHost, inlineEditor, abortSignal) => LinkedMenuGroup[] | Promise<LinkedMenuGroup[]>

Parameters

query

string

abort

() => void

editorHost

EditorHost

inlineEditor

AffineInlineEditor

abortSignal

AbortSignal

Returns

LinkedMenuGroup[] | Promise<LinkedMenuGroup[]>

Defined in

packages/blocks/src/root-block/widgets/linked-doc/config.ts:40

---

ignoreBlockTypes

ignoreBlockTypes: keyof BlockModels[]

Defined in

packages/blocks/src/root-block/widgets/linked-doc/config.ts:39

---

mobile

mobile: object

scrollContainer?

optional scrollContainer: string | HTMLElement | Window

The linked doc menu widget will scroll the container to make sure the input cursor is visible in viewport. It accepts a selector string, HTMLElement or Window

Default

getViewportElement(editorHost) this is the scrollable container in playground

scrollTopOffset?

optional scrollTopOffset: number | () => number

The offset between the top of viewport and the input cursor

Default

46 The height of header in playground

useScreenHeight?

optional useScreenHeight: boolean

Defined in

packages/blocks/src/root-block/widgets/linked-doc/config.ts:48

---

triggerKeys

triggerKeys: [string, ...string[]]

The first item of the trigger keys will be the primary key e.g. @, [[

Defined in

packages/blocks/src/root-block/widgets/linked-doc/config.ts:33