BlockSuite API Documentation / @blocksuite/affine-widget-viewport-overlay

@blocksuite/affine-widget-viewport-overlay

Classes

AffineViewportOverlayWidget

Extends

• WidgetComponent<RootBlockModel>

Constructors

Other

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

lock()

lock(): void

Returns

void

render()

render(): 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

TemplateResult<1>

Overrides

WidgetComponent.render

toggleLock()

toggleLock(): void

Returns

void

unlock()

unlock(): void

Returns

void

attributes

controllers

dev-mode

lifecycle

properties

rendering

styles

styles

static styles: CSSResult

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

Nocollapse

Overrides

WidgetComponent.styles

updates

Variables

AFFINE_VIEWPORT_OVERLAY_WIDGET

const AFFINE_VIEWPORT_OVERLAY_WIDGET: "affine-viewport-overlay-widget" = 'affine-viewport-overlay-widget'

---

viewportOverlayWidget

const viewportOverlayWidget: ExtensionType