BlockSuite API Documentation / @blocksuite/block-std / WidgetViewExtension

Function: WidgetViewExtension()

WidgetViewExtension(flavour, id, view): ExtensionType

Defined in: packages/framework/block-std/src/extension/widget-view-map.ts:22

Create a widget view extension.

Parameters

flavour

string

The flavour of the block that the widget view is for.

id

string

The id of the widget view.

view

StaticValue

The widget view lit literal.

A widget view is to provide a widget view for a block. For every target block, it's view will be rendered with the widget view.

Returns

ExtensionType

Example

import { WidgetViewExtension } from '@blocksuite/block-std';

const MyWidgetViewExtension = WidgetViewExtension('my-flavour', 'my-widget', literal`my-widget-view`);