BlockSuite API Documentation / @blocksuite/affine-widget-edgeless-selected-rect

@blocksuite/affine-widget-edgeless-selected-rect

Classes

EdgelessSelectedRectWidget

Extends

• WidgetComponent<RootBlockModel>

Constructors

Constructor

new EdgelessSelectedRectWidget(): EdgelessSelectedRectWidget

Returns

EdgelessSelectedRectWidget

Overrides

WidgetComponent<RootBlockModel>.constructor

Other

autoCompleteOff

frameOverlay

Get Signature

get frameOverlay(): FrameOverlay

Returns

FrameOverlay

gfx

Get Signature

get gfx(): GfxController

Returns

GfxController

selection

Get Signature

get selection(): GfxSelectionManager

Returns

GfxSelectionManager

surface

Get Signature

get surface(): SurfaceBlockModel | null

Returns

SurfaceBlockModel | null

zoom

Get Signature

get zoom(): number

Returns

number

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

enabledWarnings

static enabledWarnings: never[] = []

Read or set all the enabled warning categories for this class.

This property is only used in development builds.

Nocollapse

Overrides

WidgetComponent.enabledWarnings

lifecycle

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:

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

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

Variables

EDGELESS_SELECTED_RECT_WIDGET

const EDGELESS_SELECTED_RECT_WIDGET: "edgeless-selected-rect" = 'edgeless-selected-rect'