upstream-affine/blocksuite/docs/api/@blocksuite/std/index/functions/KeymapExtension.md

BlockSuite API Documentation

---

BlockSuite API Documentation / @blocksuite/std / index / 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

import { KeymapExtension } from '@blocksuite/std';

const MyKeymapExtension = KeymapExtension(std => {
  return {
    keymap: {
      'mod-a': SelectAll
    }
    options: {
      flavour: 'affine:paragraph'
    }
  }
});