BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/block-std / WidgetComponent

Class: WidgetComponent<Model, B, S> ​

Extends ​

  • LitElement<this> & DisposableClass<this>

Extended by ​

Type Parameters ​

• Model extends BlockModel = BlockModel

• B extends BlockComponent = BlockComponent

• S extends BlockService = BlockService

Constructors ​

new WidgetComponent() ​

new WidgetComponent<Model, B, S>(): WidgetComponent<Model, B, S>

Returns ​

WidgetComponent<Model, B, S>

Inherited from ​

SignalWatcher(WithDisposable(LitElement)).constructor

Defined in ​

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

Other ​

_disposables ​

protected _disposables: DisposableGroup

Inherited from ​

SignalWatcher(WithDisposable(LitElement))._disposables

Defined in ​

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

disposables ​

readonly disposables: DisposableGroup

Inherited from ​

SignalWatcher(WithDisposable(LitElement)).disposables

Defined in ​

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

virtualKeyboardPolicy ​

virtualKeyboardPolicy: string

Inherited from ​

SignalWatcher(WithDisposable(LitElement)).virtualKeyboardPolicy

Defined in ​

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

block ​

Get Signature ​

get block(): B

Returns ​

B

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:32

doc ​

Get Signature ​

get doc(): Doc

Returns ​

Doc

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:36

flavour ​

Get Signature ​

get flavour(): string

Returns ​

string

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:40

host ​

Get Signature ​

get host(): EditorHost

Returns ​

EditorHost

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:44

model ​

Get Signature ​

get model(): Model

Returns ​

Model

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:48

service ​

Get Signature ​

get service(): S

Returns ​

S

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:52

std ​

Get Signature ​

get std(): BlockStdScope

Returns ​

BlockStdScope

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:56

widgetId ​

Get Signature ​

get widgetId(): string

Returns ​

string

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:60

bindHotKey() ​

bindHotKey(keymap, options?): void

Parameters ​

keymap ​

Record<string, UIEventHandler>

options? ​
global ​

boolean

Returns ​

void

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:64

handleEvent() ​

handleEvent(name, handler, options?): void

Parameters ​

name ​

"blur" | "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" | "focus" | "contextMenu" | "wheel"

handler ​

UIEventHandler

options? ​
global ​

boolean

Returns ​

void

Defined in ​

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

lifecycle ​

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 ​

SignalWatcher(WithDisposable(LitElement)).connectedCallback

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:75

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

Overrides ​

SignalWatcher(WithDisposable(LitElement)).disconnectedCallback

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:85

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

Overrides ​

SignalWatcher(WithDisposable(LitElement)).render

Defined in ​

packages/framework/block-std/src/view/element/widget-component.ts:94

Copyright © 2022-present Toeverything