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

Function: ConfigExtensionFactory()

ConfigExtensionFactory<Config>(flavor): (config) => ExtensionType & object

Defined in: packages/framework/block-std/src/extension/config.ts:27

Create a config extension. A config extension provides a configuration object for a block flavour. The configuration object can be used like:

const config = std.provider.get(ConfigIdentifier('my-flavour'));

Type Parameters

Config

Config extends Record<string, any>

Parameters

flavor

string

The flavour of the block that the config is for.

Returns

(config) => ExtensionType & object

Example

import { ConfigExtensionFactory } from '@blocksuite/block-std';
const MyConfigExtensionFactory = ConfigExtensionFactory<ConfigType>('my-flavour');
const MyConfigExtension = MyConfigExtensionFactory({
  option1: 'value1',
  option2: 'value2',
});