Class Facet<Input, Output>

tag

reader

• get reader(): FacetReader<Output>

  Returns a facet reader for this facet, which can be used to read it but not to define values for it.

  Returns FacetReader<Output>

compute

• compute(
      deps: readonly Slot<any>[],
      get: (state: EditorState) => Input,
  ): Extension

  Create an extension that computes a value for the facet from a state. You must take care to declare the parts of the state that this value depends on, since your function is only called again for a new state when one of those parts changed.

  In cases where your value depends only on a single field, you'll want to use the from method instead.

  Parameters

  • deps: readonly Slot<any>[]
  • get: (state: EditorState) => Input

  Returns Extension

computeN

• computeN(
      deps: readonly Slot<any>[],
      get: (state: EditorState) => readonly Input[],
  ): Extension

  Create an extension that computes zero or more values for this facet from a state.

  Parameters

  • deps: readonly Slot<any>[]
  • get: (state: EditorState) => readonly Input[]

  Returns Extension

from

• from<T>(field: StateField<T>): Extension

  Shorthand method for registering a facet source with a state field as input. If the field's type corresponds to this facet's input type, the getter function can be omitted. If given, it will be used to retrieve the input from the field value.

  Type Parameters

  • T

  Parameters

  • field: StateField<T>

  Returns Extension

• from<T>(field: StateField<T>, get: (value: T) => Input): Extension

  Shorthand method for registering a facet source with a state field as input. If the field's type corresponds to this facet's input type, the getter function can be omitted. If given, it will be used to retrieve the input from the field value.

  Type Parameters

  • T

  Parameters

  • field: StateField<T>
  • get: (value: T) => Input

  Returns Extension

of

• of(value: Input): Extension

  Returns an extension that adds the given value to this facet.

  Parameters

  • value: Input

  Returns Extension

Staticdefine

• define<Input, Output = readonly Input[]>(
      config?: FacetConfig<Input, Output>,
  ): Facet<Input, Output>

  Define a new facet.

  Type Parameters

  • Input
  • Output = readonly Input[]

  Parameters

  • Optionalconfig: FacetConfig<Input, Output>

  Returns Facet<Input, Output>