Function inCheckbox

  • Creates an input control for the given checkbox element.

    The value of checkbox control is:

    • true when checkbox is checked,
    • false when it's not, or
    • undefined when it is in intermediate state.

    Parameters

    • element: HTMLInputElement

      Target checkbox element.

    Returns InCheckbox

    New input element control instance.

  • Creates an input control for the given checkbox element with default aspects.

    The value of checkbox control is:

    • true when checkbox is checked,
    • false when it's not, or
    • undefined when it is in intermediate state.

    Parameters

    • element: HTMLInputElement

      Target checkbox element.

    • aspects: {
          aspects?: Aspect<boolean, boolean> | readonly Aspect<boolean, boolean>[];
      }

      Input aspects applied by default. These are aspect converters to constructed control from the same-valued one.

      • Optional Readonly aspects?: Aspect<boolean, boolean> | readonly Aspect<boolean, boolean>[]

    Returns InCheckbox

    New input element control instance.

  • Creates an input control for the given checkbox element with custom control values.

    Type Parameters

    • TValue

      Input value type.

    Parameters

    • element: HTMLInputElement

      Target checkbox element.

    • values: InCheckbox.Values<TValue>

      All possible values of checkbox control.

    Returns InCheckbox<TValue>

    New radio input control instance.

  • Creates an input control for the given checkbox element with custom checked and unchecked control values.

    An intermediate checkbox state is represented by undefined control value.

    Type Parameters

    • TValue

      Input value type.

    Parameters

    • element: HTMLInputElement

      Target checkbox element.

    • __namedParameters: Omit<InCheckbox.Values<TValue>, "intermediate">

    Returns InCheckbox<TValue | undefined>

    New input element control instance.

Settings

Member Visibility

Theme

Generated using TypeDoc