File

libs/core/dynamic-form/checkbox/src/checkbox.model.ts

Extends

DfInteractiveBaseConfig

Index

Properties

Properties

label
Type string
Description

This field's label. It's translatable by default and supports string interpolation.

labelSizeSmall (Optional)
Type boolean
Description

Sets the checkbox label size to 'small'. Default is 'large'.

type
Description

Specifies the type of the field as CHECKBOX.

import { DfInteractiveBaseConfig } from '@allianz/taly-core/dynamic-form';

/**
 * The value to use for the `type` attribute of checkbox formfield configs.
 */
export const DfCheckboxTypeName = 'CHECKBOX';

export interface DfCheckboxConfig extends DfInteractiveBaseConfig {
  /**
   * Specifies the type of the field as `CHECKBOX`.
   */
  type: typeof DfCheckboxTypeName;

  /**
   * This field's label.
   * It's translatable by default and supports string interpolation.
   * @examples ["My label", "My label {$['bb-pgr-simple'].person.firstName}"]
   */
  label: string;

  /**
   * Sets the checkbox label size to 'small'. Default is 'large'.
   */
  labelSizeSmall?: boolean;
}

export const CheckboxLabelSize = {
  Small: 'small',
  Large: 'large'
} as const;
export type CheckboxLabelSize = (typeof CheckboxLabelSize)[keyof typeof CheckboxLabelSize];

results matching ""

    No results matching ""