Skip to main content

@lexical/extension/namedSignals

Type Aliases​

NamedSignalsOptions​

NamedSignalsOptions<Defaults> = { [K in keyof Defaults]?: Defaults[K] }

Defined in: packages/lexical-extension/src/namedSignals.ts:10

Type Parameters​

Defaults​

Defaults

NamedSignalsOutput​

NamedSignalsOutput<Defaults> = { [K in keyof Defaults]: Signal<Defaults[K]> }

Defined in: packages/lexical-extension/src/namedSignals.ts:13

Type Parameters​

Defaults​

Defaults

Functions​

namedSignals()​

namedSignals<Defaults>(defaults, opts?): NamedSignalsOutput<Defaults>

Defined in: packages/lexical-extension/src/namedSignals.ts:29

Return an object with the same shape as defaults with a Signal for each value. If specified, the second opts argument is a partial of overrides to the defaults and will be used as the initial value.

Typically used to make a reactive version of some subset of the configuration of an extension, so it can be reconfigured at runtime.

Type Parameters​

Defaults​

Defaults

Parameters​

defaults​

Defaults

The object with default values

opts?​

NamedSignalsOptions<Defaults> = {}

Overrides to those default values

Returns​

NamedSignalsOutput<Defaults>

An object with signals initialized with the default values