BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/affine-fragment-adapter-panel

@blocksuite/affine-fragment-adapter-panel ​

Classes ​

AdapterMenu ​

Extends ​

  • LitElement<this>

Constructors ​

Other ​

abortController ​
activeAdapter ​
Get Signature ​

get activeAdapter(): AdapterItem

Returns ​

AdapterItem

attributes ​

controllers ​

dev-mode ​

lifecycle ​

properties ​

rendering ​

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 ​

SignalWatcher(LitElement).render

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:

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

SignalWatcher(LitElement).styles

updates ​

AdapterPanel ​

Extends ​

  • LitElement<this> & DisposableClass<this>

Constructors ​

Other ​

styles ​

static styles: CSSResult

Overrides ​

SignalWatcher(WithDisposable(LitElement)).styles

activeAdapter ​
Get Signature ​

get activeAdapter(): AdapterItem

Returns ​

AdapterItem

store ​
transformerMiddlewares ​

attributes ​

controllers ​

dev-mode ​

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

properties ​

rendering ​

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 ​

SignalWatcher(WithDisposable(LitElement)).render

styles ​

updates ​

firstUpdated() ​

firstUpdated(): void

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

ts
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 ​

SignalWatcher(WithDisposable(LitElement)).firstUpdated

willUpdate() ​

willUpdate(changedProperties): void

Invoked before update() to compute values needed during the update.

Implement willUpdate to compute property values that depend on other properties and are used in the rest of the update process.

ts
willUpdate(changedProperties) {
  // only need to check changed properties for an expensive computation.
  if (changedProperties.has('firstName') || changedProperties.has('lastName')) {
    this.sha = computeSHA(`${this.firstName} ${this.lastName}`);
  }
}

render() {
  return html`SHA: ${this.sha}`;
}
Parameters ​
changedProperties ​

PropertyValueMap<AdapterPanel>

Returns ​

void

Overrides ​

SignalWatcher(WithDisposable(LitElement)).willUpdate

AdapterPanelBody ​

Extends ​

  • LitElement<this>

Constructors ​

Other ​

activeAdapter ​
Get Signature ​

get activeAdapter(): AdapterItem

Returns ​

AdapterItem

docSnapshot ​
Get Signature ​

get docSnapshot(): DocSnapshot | null

Returns ​

DocSnapshot | null

htmlContent ​
Get Signature ​

get htmlContent(): string

Returns ​

string

isHtmlPreview ​
Get Signature ​

get isHtmlPreview(): boolean

Returns ​

boolean

markdownContent ​
Get Signature ​

get markdownContent(): string

Returns ​

string

plainTextContent ​
Get Signature ​

get plainTextContent(): string

Returns ​

string

attributes ​

controllers ​

dev-mode ​

lifecycle ​

properties ​

rendering ​

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 ​

SignalWatcher(LitElement).render

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:

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

SignalWatcher(LitElement).styles

updates ​

AdapterPanelHeader ​

Extends ​

  • LitElement<this>

Constructors ​

Other ​

activeAdapter ​
Get Signature ​

get activeAdapter(): AdapterItem

Returns ​

AdapterItem

updateActiveContent() ​

attributes ​

controllers ​

dev-mode ​

lifecycle ​

properties ​

rendering ​

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 ​

SignalWatcher(LitElement).render

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:

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

SignalWatcher(LitElement).styles

updates ​

Variables ​

AFFINE_ADAPTER_MENU ​

const AFFINE_ADAPTER_MENU: "affine-adapter-menu" = 'affine-adapter-menu'

AFFINE_ADAPTER_PANEL ​

const AFFINE_ADAPTER_PANEL: "affine-adapter-panel" = 'affine-adapter-panel'

AFFINE_ADAPTER_PANEL_BODY ​

const AFFINE_ADAPTER_PANEL_BODY: "affine-adapter-panel-body" = 'affine-adapter-panel-body'

AFFINE_ADAPTER_PANEL_HEADER ​

const AFFINE_ADAPTER_PANEL_HEADER: "affine-adapter-panel-header" = 'affine-adapter-panel-header'

Copyright © 2022-present Toeverything