docs(editor): scaffolding docs generator (#10925)

This commit is contained in:
Saul-Mirone
2025-03-17 12:51:08 +00:00
parent 363c9799f3
commit 1d04438049
59 changed files with 2101 additions and 9 deletions

View File

@@ -0,0 +1,45 @@
[**@blocksuite/block-std**](../../../../@blocksuite/block-std/README.md)
***
[BlockSuite API Documentation](../../../../README.md) / [@blocksuite/block-std](../../README.md) / [index](../README.md) / WidgetViewExtension
# Function: WidgetViewExtension()
> **WidgetViewExtension**(`flavour`, `id`, `view`): `ExtensionType`
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
```ts
import { WidgetViewExtension } from '@blocksuite/block-std';
const MyWidgetViewExtension = WidgetViewExtension('my-flavour', 'my-widget', literal`my-widget-view`);