BlockSuite API Documentation / @blocksuite/affine-widget-page-dragging-area

@blocksuite/affine-widget-page-dragging-area

Classes

AffinePageDraggingAreaWidget

Extends

• WidgetComponent<RootBlockModel>

Constructors

Other

excludeFlavours

static excludeFlavours: string[]

rect

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.

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

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

Overrides

WidgetComponent.disconnectedCallback

render()

render(): typeof nothing | TemplateResult<1>

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

typeof nothing | TemplateResult<1>

Overrides

WidgetComponent.render

attributes

controllers

dev-mode

properties

rendering

styles

updates

firstUpdated()

firstUpdated(): void

Invoked when the element is first updated. Implement to perform one time work on the element after update.

firstUpdated() {
  this.renderRoot.getElementById('my-text-area').focus();
}

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Returns

void

Overrides

WidgetComponent.firstUpdated

Variables

AFFINE_PAGE_DRAGGING_AREA_WIDGET

const AFFINE_PAGE_DRAGGING_AREA_WIDGET: "affine-page-dragging-area-widget" = 'affine-page-dragging-area-widget'

---

pageDraggingAreaWidget

const pageDraggingAreaWidget: ExtensionType