BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/affine-widget-note-slicer

@blocksuite/affine-widget-note-slicer ​

Classes ​

NoteSlicer ​

Extends ​

Constructors ​

Other ​

_editorHost ​
Get Signature ​

get _editorHost(): EditorHost

Returns ​

EditorHost

_noteBlock ​
Get Signature ​

get _noteBlock(): NoteBlockComponent | null

Returns ​

NoteBlockComponent | null

_selection ​
Get Signature ​

get _selection(): GfxSelectionManager

Returns ​

GfxSelectionManager

_viewportOffset ​
Get Signature ​

get _viewportOffset(): object

Returns ​

object

left ​

left: number

top ​

top: number

_zoom ​
Get Signature ​

get _zoom(): number

Returns ​

number

gfx ​
Get Signature ​

get gfx(): GfxController

Returns ​

GfxController

selectedRectEle ​
Get Signature ​

get selectedRectEle(): EdgelessSelectedRectWidget | null

Returns ​

EdgelessSelectedRectWidget | null

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 ​

WidgetComponent.connectedCallback

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 ​

WidgetComponent.disconnectedCallback

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 ​

WidgetComponent.render

attributes ​

controllers ​

dev-mode ​

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:

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

WidgetComponent.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 ​

WidgetComponent.firstUpdated

updated() ​

protected updated(_changedProperties): void

Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Parameters ​
_changedProperties ​

PropertyValueMap<any> | Map<PropertyKey, unknown>

Map of changed properties with old values

Returns ​

void

Overrides ​

WidgetComponent.updated

Variables ​

NOTE_SLICER_WIDGET ​

const NOTE_SLICER_WIDGET: "note-slicer" = 'note-slicer'

noteSlicerWidget ​

const noteSlicerWidget: ExtensionType

Copyright © 2022-present Toeverything