BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/presets / OutlineViewer

Class: OutlineViewer ​

Extends ​

Constructors ​

new OutlineViewer() ​

new OutlineViewer(): OutlineViewer

Returns ​

OutlineViewer

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/block-std/dist/view/utils/with-disposable.d.ts:4

disposables ​

readonly disposables: DisposableGroup

Inherited from ​

SignalWatcher(WithDisposable(LitElement)).disposables

Defined in ​

packages/framework/block-std/dist/view/utils/with-disposable.d.ts:5

styles ​

static styles: CSSResult

Overrides ​

SignalWatcher(WithDisposable(LitElement)).styles

Defined in ​

packages/presets/src/fragments/outline/outline-viewer.ts:29

editor ​

Defined in ​

packages/presets/src/fragments/outline/outline-viewer.ts:278

toggleOutlinePanel ​

Defined in ​

packages/presets/src/fragments/outline/outline-viewer.ts:281

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/presets/src/fragments/outline/outline-viewer.ts:178

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/presets/src/fragments/outline/outline-viewer.ts:192

rendering ​

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 ​

SignalWatcher(WithDisposable(LitElement)).render

Defined in ​

packages/presets/src/fragments/outline/outline-viewer.ts:197

Copyright © 2022-present Toeverything