BlockSuite API Documentation / @blocksuite/presets / CommentPanel

Class: CommentPanel

Extends

• ShadowlessElement<this> & DisposableClass<this>

Constructors

new CommentPanel()

new CommentPanel(): CommentPanel

Returns

CommentPanel

Inherited from

WithDisposable(ShadowlessElement).constructor

Defined in

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

Other

_disposables

protected _disposables: DisposableGroup

Inherited from

WithDisposable(ShadowlessElement)._disposables

Defined in

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

---

commentManager

commentManager: null | CommentManager = null

Defined in

packages/presets/src/fragments/comment/comment-panel.ts:61

---

disposables

readonly disposables: DisposableGroup

Inherited from

WithDisposable(ShadowlessElement).disposables

Defined in

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

---

virtualKeyboardPolicy

virtualKeyboardPolicy: string

Inherited from

WithDisposable(ShadowlessElement).virtualKeyboardPolicy

Defined in

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

---

connectedCount

static connectedCount: WeakMap<Constructor, WeakMap<Node, number>>

Inherited from

WithDisposable(ShadowlessElement).connectedCount

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:5

---

onDisconnectedMap

static onDisconnectedMap: WeakMap<Constructor, null | () => void>

Inherited from

WithDisposable(ShadowlessElement).onDisconnectedMap

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:6

---

styles

static styles: CSSResult

Overrides

WithDisposable(ShadowlessElement).styles

Defined in

packages/presets/src/fragments/comment/comment-panel.ts:12

---

editor

Defined in

packages/presets/src/fragments/comment/comment-panel.ts:110

---

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

WithDisposable(ShadowlessElement).connectedCallback

Defined in

packages/presets/src/fragments/comment/comment-panel.ts:77

lifecycle

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

Inherited from

WithDisposable(ShadowlessElement).disconnectedCallback

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:12

rendering

createRenderRoot()

createRenderRoot(): this

Returns

this

Inherited from

WithDisposable(ShadowlessElement).createRenderRoot

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:11

---

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

WithDisposable(ShadowlessElement).render

Defined in

packages/presets/src/fragments/comment/comment-panel.ts:84

styles

finalizeStyles()

protected static finalizeStyles(styles?): CSSResultOrNative[]

Takes the styles the user supplied via the static styles property and returns the array of styles to apply to the element. Override this method to integrate into a style management system.

Styles are deduplicated preserving the last instance in the list. This is a performance optimization to avoid duplicated styles that can occur especially when composing via subclassing. The last item is kept to try to preserve the cascade order with the assumption that it's most important that last added styles override previous styles.

Parameters

styles?

CSSResultGroup

Returns

CSSResultOrNative[]

Nocollapse

Inherited from

WithDisposable(ShadowlessElement).finalizeStyles

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:7