BlockSuite API Documentation / @blocksuite/blocks / EdgelessElementToolbarWidget
Class: EdgelessElementToolbarWidget
Extends
Constructors
new EdgelessElementToolbarWidget()
new EdgelessElementToolbarWidget():
EdgelessElementToolbarWidget
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
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
moreGroups
moreGroups:
MenuItemGroup
<ElementToolbarMoreMenuContext
>[]
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:153
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/element-toolbar/index.ts:156
enableNoteSlicer
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:445
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
selectedIds
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:456
selection
get
selection():EdgelessSelectionManager
Returns
EdgelessSelectionManager
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:160
service
get
service():S
Returns
S
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:17
slots
get
slots():object
Returns
object
copyAsPng
copyAsPng:
Slot
<object
>
Type declaration
blocks
blocks:
EdgelessBlockModelType
[]
shapes
shapes:
SurfaceModel
[]
cursorUpdated
cursorUpdated:
Slot
<string
>
docLinkClicked
docLinkClicked:
Slot
<object
>
Type declaration
pageId
pageId:
string
params?
optional
params:object
params.blockIds?
optional
params.blockIds:string
[]
params.elementIds?
optional
params.elementIds:string
[]
params.mode?
optional
params.mode:"edgeless"
|"page"
draggingAreaUpdated
draggingAreaUpdated:
Slot
<void
>
edgelessToolUpdated
edgelessToolUpdated:
Slot
<TextTool
|BrushTool
|ConnectorTool
|CopilotSelectionTool
|EraserTool
|FrameNavigatorTool
|FrameTool
|LassoTool
|MindmapTool
|NoteTool
|PanTool
|ShapeTool
|DefaultTool
|object
>
elementResizeEnd
elementResizeEnd:
Slot
<void
>
elementResizeStart
elementResizeStart:
Slot
<void
>
fullScreenToggled
fullScreenToggled:
Slot
<void
>
navigatorFrameChanged
navigatorFrameChanged:
Slot
<FrameBlockModel
>
navigatorSettingUpdated
navigatorSettingUpdated:
Slot
<object
>
Type declaration
blackBackground?
optional
blackBackground:boolean
fillScreen?
optional
fillScreen:boolean
hideToolbar?
optional
hideToolbar:boolean
pressShiftKeyUpdated
pressShiftKeyUpdated:
Slot
<boolean
>
readonlyUpdated
readonlyUpdated:
Slot
<boolean
>
tagClicked
tagClicked:
Slot
<object
>
Type declaration
tagId
tagId:
string
toggleNoteSlicer
toggleNoteSlicer:
Slot
<void
>
toolbarLocked
toolbarLocked:
Slot
<boolean
>
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:164
std
get
std():BlockStdScope
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:18
surface
get
surface():SurfaceBlockComponent
Returns
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:168
toolbarVisible
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:459
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
registerEntry()
registerEntry(
entry
):void
Parameters
• entry: CustomEntry
Returns
void
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:336
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/element-toolbar/index.ts:340
lifecycle
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
Inherited from
WidgetComponent
.connectedCallback
Defined in
packages/framework/block-std/dist/view/element/widget-component.d.ts:23
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/element-toolbar/index.ts:111
updates
firstUpdated()
protected
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
Defined in
packages/blocks/src/root-block/widgets/element-toolbar/index.ts:265