BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / AffineLinkedDocWidget

Class: AffineLinkedDocWidget ​

Extends ​

Constructors ​

new AffineLinkedDocWidget() ​

new AffineLinkedDocWidget(): AffineLinkedDocWidget

Returns ​

AffineLinkedDocWidget

Inherited from ​

WidgetComponent.constructor

Defined in ​

node_modules/@lit/reactive-element/development/reactive-element.d.ts:504

Other ​

_disposables ​

protected _disposables: DisposableGroup

Inherited from ​

WidgetComponent._disposables

Defined in ​

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

disposables ​

readonly disposables: DisposableGroup

Inherited from ​

WidgetComponent.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.global?: boolean

Returns ​

void

Inherited from ​

WidgetComponent.handleEvent

Defined in ​

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

virtualKeyboardPolicy ​

virtualKeyboardPolicy: string

Inherited from ​

WidgetComponent.virtualKeyboardPolicy

Defined in ​

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

block ​

get block(): B

Returns ​

B

Inherited from ​

WidgetComponent.block

Defined in ​

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

config ​

get config(): LinkedWidgetConfig

Returns ​

LinkedWidgetConfig

Defined in ​

packages/blocks/src/root-block/widgets/linked-doc/index.ts:167

doc ​

get doc(): Doc

Returns ​

Doc

Inherited from ​

WidgetComponent.doc

Defined in ​

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

flavour ​

get flavour(): string

Returns ​

string

Inherited from ​

WidgetComponent.flavour

Defined in ​

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

host ​

get host(): EditorHost

Returns ​

EditorHost

Inherited from ​

WidgetComponent.host

Defined in ​

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

model ​

get model(): Model

Returns ​

Model

Inherited from ​

WidgetComponent.model

Defined in ​

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

service ​

get service(): S

Returns ​

S

Inherited from ​

WidgetComponent.service

Defined in ​

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

std ​

get std(): BlockStdScope

Returns ​

BlockStdScope

Inherited from ​

WidgetComponent.std

Defined in ​

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

widgetId ​

get widgetId(): string

Returns ​

string

Inherited from ​

WidgetComponent.widgetId

Defined in ​

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

bindHotKey() ​

bindHotKey(keymap, options?): void

Parameters ​

• keymap: Record<string, UIEventHandler>

• options?

• options.global?: boolean

Returns ​

void

Inherited from ​

WidgetComponent.bindHotKey

Defined in ​

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

connectedCallback() ​

connectedCallback(): void

Invoked when the component is added to the document's DOM.

In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

ts
connectedCallback() {
  super.connectedCallback();
  addEventListener('keydown', this._handleKeydown);
}

Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

Returns ​

void

Overrides ​

WidgetComponent.connectedCallback

Defined in ​

packages/blocks/src/root-block/widgets/linked-doc/index.ts:230

showLinkedDocPopover() ​

showLinkedDocPopover(inlineEditor, triggerKey): undefined | LinkedDocPopover

Parameters ​

• inlineEditor: AffineInlineEditor

• triggerKey: string

Returns ​

undefined | LinkedDocPopover

Defined in ​

packages/blocks/src/root-block/widgets/linked-doc/index.ts:114

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.

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

An element may be re-connected after being disconnected.

Returns ​

void

Inherited from ​

WidgetComponent.disconnectedCallback

Defined in ​

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

rendering ​

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 ​

WidgetComponent.render

Defined in ​

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

Copyright © 2022-present Toeverything