Class FieldShare<TValue>

A kind of component share containing a form field.

This class may be inherited to represent a specific type of forms. E.g. to distinguish multiple fields defined within the same component.

Type Parameters

  • TValue = any

    Field value type.

Hierarchy

  • Share<Field<TValue>>
    • FieldShare

Constructors

constructor

Accessors

[toStringTag] name share share

Methods

addSharer createRegistrar perContext selectValue shareValue toString valueFor

Constructors

constructor

  • Constructs new component share.

    Type Parameters

    • TValue = any

    Parameters

    • name: string

      A human-readable name of the share.

    • Optional options: Options<Field<TValue, any>>

      Constructed share options.

    Returns FieldShare<TValue>

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

name

  • get name(): string

  • A human-readable name of the name.

    Returns string

share

  • get share(): this

  • Refers to itself.

    Returns this

Static share

Methods

addSharer

  • Registers a sharer component.

    The registration is necessary for consumers to be able to find the element bound to sharer by that element's name.

    Returns

    Sharer registration supply. Revokes the sharer registration once cut off.

    Parameters

    • defContext: DefinitionContext<any>

      The definition context of the sharer component.

    • Optional options: Options

      Value sharing options.

    Returns Supply

createRegistrar

  • Creates a shared value registrar that shares a value created by the given provider.

    Returns

    New shared value registrar.

    Type Parameters

    • TSharer extends object

      Sharer component type.

    Parameters

    • target: Target<AfterEvent<[Field<TValue, any>?]>, SharedValue<Field<TValue, any>> | AfterEvent<SharedValue<Field<TValue, any>>[]>, ComponentContext<TSharer>>

      Shared value definition target.

    • provider: Provider<Field<TValue, any>, TSharer>

      Shared value provider.

    Returns Registrar<Field<TValue, any>>

perContext

  • Parameters

    • target: Target<Field<TValue, any>, any>

    Returns Definition<Field<TValue, any>>

selectValue

  • Selects a shared value among candidates.

    It is especially useful when the value shared by multiple sharers.

    By default:

    • Prefers bare value.
    • Prefers the value from SharedValue.Detailed detailed specifier with higher priority (i.e. lesser SharedValue.Details.priority priority value).
    • Prefers the value declared last.

    Returns

    Either selected value, or undefined when not present.

    Parameters

    • Rest ...values: SharedValue<Field<TValue, any>>[]

      The values shared by sharers. May contain a SharedValue.Detailed detailed value specifiers in addition to pure values.

    Returns undefined | Field<TValue, any>

shareValue

  • Shares a value by providing it for the sharer component context.

    Returns

    A builder of shared value for component context.

    Parameters

    • registrar: Registrar<Field<TValue, any>>

      Shared value registrar.

    Returns void

toString

  • Returns string

valueFor

  • Locates a shared value for the consuming component.

    Searches among parent elements for the one bound to the sharer component, then obtains the shared value from the sharer's context.

    Returns

    An AfterEvent keeper of the shared value and its sharer context, if found.

    Parameters

    • consumer: ComponentContext<any>

      Consumer component context.

    • Optional options: Options

      Location options.

    Returns AfterEvent<[] | [Field<TValue, any>, ComponentContext<any>]>

Settings

Member Visibility

Theme

Generated using TypeDoc