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

Function: WidgetViewMapExtension()

WidgetViewMapExtension(flavour, widgetViewMap): ExtensionType

Create a widget view map extension.

Parameters

• flavour: Flavour

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

• widgetViewMap: WidgetViewMapType

A map of widget names to widget view lit literal.

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

Returns

ExtensionType

Example

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

const MyWidgetViewMapExtension = WidgetViewMapExtension('my-flavour', {
 'my-widget': literal`my-widget-view`
});

## Defined in

packages/framework/block-std/src/extension/widget-view-map.ts:23