BlockSuite API Documentation / @blocksuite/blocks / AffineAIPanelWidget

Class: AffineAIPanelWidget

Extends

• WidgetComponent

Constructors

new AffineAIPanelWidget()

new AffineAIPanelWidget(): AffineAIPanelWidget

Returns

AffineAIPanelWidget

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

---

ctx

ctx: unknown = null

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:173

---

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

"click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "beforeInput" | "blur" | "focus" | "contextMenu" | "wheel"

handler

UIEventHandler

options?

global

boolean

Returns

void

Inherited from

WidgetComponent.handleEvent

Defined in

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

---

virtualKeyboardPolicy

virtualKeyboardPolicy: string

Inherited from

WidgetComponent.virtualKeyboardPolicy

Defined in

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

---

answer

Get Signature

get answer(): null | string

Returns

null | string

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:316

---

block

Get Signature

get block(): B

Returns

B

Inherited from

WidgetComponent.block

Defined in

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

---

config

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:559

---

doc

Get Signature

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 Signature

get flavour(): string

Returns

string

Inherited from

WidgetComponent.flavour

Defined in

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

---

generatingElement

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:562

---

host

Get Signature

get host(): EditorHost

Returns

EditorHost

Inherited from

WidgetComponent.host

Defined in

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

---

inputText

Get Signature

get inputText(): null | string

Returns

null | string

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:320

---

model

Get Signature

get model(): Model

Returns

Model

Inherited from

WidgetComponent.model

Defined in

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

---

service

Get Signature

get service(): S

Returns

S

Inherited from

WidgetComponent.service

Defined in

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

---

state

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:565

---

std

Get Signature

get std(): BlockStdScope

Returns

BlockStdScope

Inherited from

WidgetComponent.std

Defined in

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

---

viewportOverlayWidget

Get Signature

get viewportOverlayWidget(): null | AffineViewportOverlayWidget

Returns

null | AffineViewportOverlayWidget

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:324

---

widgetId

Get Signature

get widgetId(): string

Returns

string

Inherited from

WidgetComponent.widgetId

Defined in

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

---

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

keymap

Record<string, UIEventHandler>

options?

global

boolean

Returns

void

Inherited from

WidgetComponent.bindHotKey

Defined in

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

---

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/ai-panel/ai-panel.ts:424

---

discard()

discard(): void

Returns

void

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:175

---

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/ai-panel/ai-panel.ts:451

---

generate()

generate(): void

You can evaluate this method multiple times to regenerate the answer.

Returns

void

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:199

---

hide()

hide(shouldTriggerCallback): void

Parameters

shouldTriggerCallback

boolean = true

Returns

void

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:241

---

onInput()

onInput(text): void

Parameters

text

string

Returns

void

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:254

---

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/ai-panel/ai-panel.ts:457

---

restoreSelection()

restoreSelection(): void

Returns

void

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:259

---

setState()

setState(state, reference): void

Parameters

state

AffineAIPanelState

reference

Element

Returns

void

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:268

---

showDiscardModal()

showDiscardModal(): Promise<boolean>

Returns

Promise<boolean>

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:273

---

stopGenerating()

stopGenerating(): void

Returns

void

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:291

---

toggle()

toggle(reference, input?, shouldTriggerCallback?): void

Parameters

reference

Element

input?

string

shouldTriggerCallback?

boolean

Returns

void

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:299

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

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:42

updates

willUpdate()

protected willUpdate(changed): 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.

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

changed

PropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Overrides

WidgetComponent.willUpdate

Defined in

packages/blocks/src/root-block/widgets/ai-panel/ai-panel.ts:529