BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/presets / OutlinePanel

Class: OutlinePanel ​

Extends ​

  • LitElement<this> & DisposableClass<this>

Constructors ​

new OutlinePanel() ​

new OutlinePanel(): OutlinePanel

Returns ​

OutlinePanel

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

styles ​

static styles: CSSResult

Overrides ​

SignalWatcher(WithDisposable(LitElement)).styles

Defined in ​

packages/presets/src/fragments/outline/outline-panel.ts:57

doc ​

get doc(): Doc

Returns ​

Doc

Defined in ​

packages/presets/src/fragments/outline/outline-panel.ts:78

edgeless ​

get edgeless(): null | EdgelessRootBlockComponent

Returns ​

null | EdgelessRootBlockComponent

Defined in ​

packages/presets/src/fragments/outline/outline-panel.ts:82

editor ​

Defined in ​

packages/presets/src/fragments/outline/outline-panel.ts:163

fitPadding ​

Defined in ​

packages/presets/src/fragments/outline/outline-panel.ts:166

host ​

get host(): null | EditorHost

Returns ​

null | EditorHost

Defined in ​

packages/presets/src/fragments/outline/outline-panel.ts:86

mode ​

get mode(): DocMode

Returns ​

DocMode

Defined in ​

packages/presets/src/fragments/outline/outline-panel.ts:90

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-panel.ts:114

rendering ​

render() ​

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

undefined | TemplateResult<1>

Overrides ​

SignalWatcher(WithDisposable(LitElement)).render

Defined in ​

packages/presets/src/fragments/outline/outline-panel.ts:119

Copyright © 2022-present Toeverything