Skip to content

BlockSuite API Documentation / @blocksuite/virgo / VirgoHookService

Class: VirgoHookService<TextAttributes> ​

Contents ​

Type parameters ​

• TextAttributes extends BaseTextAttributes

Constructors ​

new VirgoHookService(editor, hooks) ​

new VirgoHookService<TextAttributes>(editor, hooks): VirgoHookService<TextAttributes>

Parameters ​

• editor: VEditor<TextAttributes>

• hooks: Object= {}

• hooks.beforeinput?: (props) => null | VBeforeinputHookCtx<TextAttributes>

• hooks.compositionEnd?: (props) => null | VCompositionEndHookCtx<TextAttributes>

Returns ​

VirgoHookService<TextAttributes>

Source ​

packages/virgo/src/services/hook.ts:29

Properties ​

editor ​

readonly editor: VEditor<TextAttributes>

Source ​

packages/virgo/src/services/hook.ts:30


hooks ​

readonly hooks: Object = {}

Type declaration ​

beforeinput? ​

beforeinput?: (props) => null | VBeforeinputHookCtx<TextAttributes>

Parameters ​

• props: VBeforeinputHookCtx<TextAttributes>

Returns ​

null | VBeforeinputHookCtx<TextAttributes>

compositionEnd? ​

compositionEnd?: (props) => null | VCompositionEndHookCtx<TextAttributes>

Parameters ​

• props: VCompositionEndHookCtx<TextAttributes>

Returns ​

null | VCompositionEndHookCtx<TextAttributes>

Source ​

packages/virgo/src/services/hook.ts:31


Generated using typedoc-plugin-markdown and TypeDoc