BlockSuite API Documentation / @blocksuite/blocks / AffineFormatBarWidget

Class: AffineFormatBarWidget

Extends

• WidgetComponent

Constructors

new AffineFormatBarWidget()

new AffineFormatBarWidget(): AffineFormatBarWidget

Returns

AffineFormatBarWidget

Inherited from

WidgetComponent.constructor

Defined in

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

Other

_disposables

protected _disposables: DisposableGroup

Inherited from

WidgetComponent._disposables

Defined in

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

---

disposables

readonly disposables: DisposableGroup

Inherited from

WidgetComponent.disposables

Defined in

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

---

handleEvent()

handleEvent: (name, handler, options?) => void

Parameters

• name: "pan" | "click" | "blur" | "focus" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "beforeInput" | "drop" | "contextMenu" | "wheel"

• handler: UIEventHandler

• options?

• options.global?: boolean

Returns

void

Inherited from

WidgetComponent.handleEvent

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:9

---

moreGroups

moreGroups: MenuItemGroup<FormatBarContext>[]

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:63

---

block

get block(): B

Returns

B

Inherited from

WidgetComponent.block

Defined in

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

---

configItems

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:587

---

displayType

get displayType(): "text" | "block" | "none" | "native"

Returns

"text" | "block" | "none" | "native"

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:69

---

doc

get doc(): Doc

Returns

Doc

Inherited from

WidgetComponent.doc

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:13

---

flavour

get flavour(): string

Returns

string

Inherited from

WidgetComponent.flavour

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:14

---

formatBarElement

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:590

---

host

get host(): EditorHost

Returns

EditorHost

Inherited from

WidgetComponent.host

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:15

---

model

get model(): Model

Returns

Model

Inherited from

WidgetComponent.model

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:16

---

nativeRange

get nativeRange(): null | Range

Returns

null | Range

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:73

---

selectedBlocks

get selectedBlocks(): BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>[]

Returns

BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>[]

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:79

---

service

get service(): S

Returns

S

Inherited from

WidgetComponent.service

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:17

---

std

get std(): BlockStdScope

Returns

BlockStdScope

Inherited from

WidgetComponent.std

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:18

---

widgetId

get widgetId(): string

Returns

string

Inherited from

WidgetComponent.widgetId

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:19

---

addBlockTypeSwitch()

addBlockTypeSwitch(config): AffineFormatBarWidget

Parameters

• config

• config.flavour: Flavour

• config.icon: TemplateResult | () => HTMLElement

• config.name?: string

• config.type?: string

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:420

---

addDivider()

addDivider(): AffineFormatBarWidget

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:443

---

addHighlighterDropdown()

addHighlighterDropdown(): AffineFormatBarWidget

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:448

---

addInlineAction()

addInlineAction(config): AffineFormatBarWidget

Parameters

• config: Omit<InlineActionConfigItem, "type">

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:453

---

addParagraphAction()

addParagraphAction(config): AffineFormatBarWidget

Parameters

• config: Omit<ParagraphActionConfigItem, "type">

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:458

---

addParagraphDropdown()

addParagraphDropdown(): AffineFormatBarWidget

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:463

---

addRawConfigItems()

addRawConfigItems(configItems, index?): AffineFormatBarWidget

Parameters

• configItems: FormatBarConfigItem[]

• index?: number

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:468

---

addTextStyleToggle()

addTextStyleToggle(config): AffineFormatBarWidget

Parameters

• config

• config.action

• config.icon: TemplateResult | () => HTMLElement

• config.key: "bold" | "link" | "strike" | "latex" | "italic" | "code" | "underline"

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:477

---

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

• keymap: Record<string, UIEventHandler>

• options?

• options.global?: boolean

Returns

void

Inherited from

WidgetComponent.bindHotKey

Defined in

packages/framework/block-std/dist/view/element/widget-component.d.ts:20

---

clearConfig()

clearConfig(): AffineFormatBarWidget

Returns

AffineFormatBarWidget

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:502

---

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.

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

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:507

---

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

Overrides

WidgetComponent.disconnectedCallback

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:537

---

render()

render(): TemplateResult<1> | typeof nothing

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> | typeof nothing

Overrides

WidgetComponent.render

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:544

---

reset()

reset(): void

Returns

void

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:560

styles

styles

static styles: CSSResult = formatBarStyle

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

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:49

updates

updated()

updated(): 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.

Returns

void

Overrides

WidgetComponent.updated

Defined in

packages/blocks/src/root-block/widgets/format-bar/format-bar.ts:565