BlockSuite API Documentation / @blocksuite/blocks / EdgelessCopilotWidget
Class: EdgelessCopilotWidget
Extends
Constructors
new EdgelessCopilotWidget()
new EdgelessCopilotWidget():
EdgelessCopilotWidget
Returns
Inherited from
Defined in
node_modules/.pnpm/@[email protected]/node_modules/@lit/reactive-element/development/reactive-element.d.ts:504
Other
_disposables
protected
_disposables:DisposableGroup
Inherited from
Defined in
packages/framework/block-std/dist/view/utils/with-disposable.d.ts:4
disposables
readonly
disposables:DisposableGroup
Inherited from
Defined in
packages/framework/block-std/dist/view/utils/with-disposable.d.ts:5
groups
groups:
AIItemGroupConfig
[] =[]
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:53
handleEvent()
handleEvent: (
name
,handler
,options
?) =>void
Parameters
• name: "pan"
| "click"
| "doubleClick"
| "tripleClick"
| "pointerDown"
| "pointerMove"
| "pointerUp"
| "pointerOut"
| "dragStart"
| "dragMove"
| "dragEnd"
| "pinch"
| "keyDown"
| "keyUp"
| "selectionChange"
| "compositionStart"
| "compositionUpdate"
| "compositionEnd"
| "cut"
| "copy"
| "paste"
| "beforeInput"
| "blur"
| "focus"
| "drop"
| "contextMenu"
| "wheel"
• handler: UIEventHandler
• options?
• options.global?: boolean
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:9
block
get
block():B
Returns
B
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:12
doc
get
doc():Doc
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:13
edgeless
get
edgeless():EdgelessRootBlockComponent
Returns
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:55
flavour
get
flavour():string
Returns
string
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:14
host
get
host():EditorHost
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:15
model
get
model():Model
Returns
Model
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:16
selectionElem
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:288
selectionModelRect
get
selectionModelRect():DOMRect
Returns
DOMRect
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:59
selectionRect
get
selectionRect():object
Returns
object
height
height:
number
width
width:
number
x
x:
number
y
y:
number
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:63
service
get
service():S
Returns
S
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:17
std
get
std():BlockStdScope
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:18
visible
get
visible():boolean
set
visible(visible
):void
Parameters
• visible: boolean
Returns
boolean
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:67
widgetId
get
widgetId():string
Returns
string
Inherited from
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?
• options.global?: boolean
Returns
void
Inherited from
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/edgeless-copilot/index.ts:190
determineInsertionBounds()
determineInsertionBounds(
width
,height
):Bound
Parameters
• width: number
= 800
• height: number
= 95
Returns
Bound
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:230
hideCopilotPanel()
hideCopilotPanel():
void
Returns
void
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:248
lockToolbar()
lockToolbar(
disabled
):void
Parameters
• disabled: boolean
Returns
void
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:254
render()
render():
TemplateResult
<1
> | typeofnothing
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
Defined in
packages/blocks/src/root-block/widgets/edgeless-copilot/index.ts:258
lifecycle
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
Inherited from
WidgetComponent
.disconnectedCallback
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:24
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/edgeless-copilot/index.ts:36