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,49 @@
[**@blocksuite/block-std**](../../../../@blocksuite/block-std/README.md)
***
[BlockSuite API Documentation](../../../../README.md) / [@blocksuite/block-std](../../README.md) / [index](../README.md) / KeymapExtension
# Function: KeymapExtension()
> **KeymapExtension**(`keymapFactory`, `options`?): `ExtensionType`
Create a keymap extension.
## Parameters
### keymapFactory
(`std`) => `Record`\<`string`, `UIEventHandler`\>
Create keymap of the extension.
It should return an object with `keymap` and `options`.
`keymap` is a record of keymap.
### options?
`EventOptions`
`options` is an optional object that restricts the event to be handled.
## Returns
`ExtensionType`
## Example
```ts
import { KeymapExtension } from '@blocksuite/block-std';
const MyKeymapExtension = KeymapExtension(std => {
return {
keymap: {
'mod-a': SelectAll
}
options: {
flavour: 'affine:paragraph'
}
}
});
```