Class InGroupControls<TModel>Abstract

Input group controls.

Type Parameters

  • TModel

    Group model type, i.e. its value type.

Hierarchy

Implements

Constructors

Properties

on: OnEvent<[InGroup.Entry<TModel, keyof TModel>[], InGroup.Entry<TModel, keyof TModel>[]]>

An OnEvent sender of container updates.

Sends two arrays on each container update: the first one contains added control entries, while the second one contains removed control entries.

The [OnEvent__symbol] property is an alias of this one.

read: AfterEvent<[InGroup.Snapshot<TModel>]>

An AfterEvent keeper of input container contents.

The [AfterEvent__symbol] property is an alias of this one.

Methods

  • Removes input control with the given key.

    Calling this method is the same as calling set(key, undefined)

    Parameters

    • key: keyof TModel

      A key of input control to remove. I.e. corresponding model property key.

    Returns void

  • Sets input control with the given key.

    Replaces existing control if already present.

    Type Parameters

    • TKey extends string | number | symbol

      Model key type.

    Parameters

    • key: TKey

      A key of input control to set. I.e. corresponding model property key.

    • control: undefined | InControl<TModel[TKey]>

      Input control to add, or undefined to remove control.

    Returns Supply

    A supply of just added control that removes it once cut off. A cut off supply when set to undefined.

  • Sets multiple input controls at a time.

    Parameters

    • controls: Controls<TModel>

      A map of controls under their keys. A value can be undefined to remove corresponding control.

    Returns Supply

    A supply of just added controls that removes them once cut off.

Generated using TypeDoc