libs/core/dynamic-form/switcher/src/switcher.model.ts
Configuration for a dynamic input field.
Properties |
|
| label | |
| Type |
string
|
|
Description
|
This field's label. It's translatable by default and supports string interpolation. Example : |
| labelPosition (Optional) | |
| Type |
SwitcherLabelPosition
|
|
Description
|
Sets the label position to be on the left or right. Default is left. |
| size (Optional) | |
| Type |
SwitcherSize
|
|
Description
|
Sets the switcher size to be small or large. Default is small. |
| type | |
| Type |
typeof DfSwitcherTypeName
|
|
Description
|
Specifies the type of the field as |
| value (Optional) | |
| Type |
boolean
|
|
Description
|
The field's initial value. |
| hint (Optional) | |
| Type |
string
|
|
Description
|
The hint text to be displayed under the field. It's translatable by default and supports string interpolation. Example : |
| note (Optional) | |
| Type |
string
|
|
Description
|
The note text is displayed in an info message box below the field. It's translatable by default and supports string interpolation. Example : |
| onBlurEvent (Optional) | |
| Type |
DfInteractiveEventConfig
|
|
Description
|
Configure either a PFE action or service activator configuration handler for the field's |
| onValueChangesEvent (Optional) | |
| Type |
DfInteractiveEventConfig
|
|
Description
|
Configure either a PFE action or service activator configuration handler for the field's |
| validators (Optional) | |
| Type |
DynamicFormValidationConfig[]
|
|
Description
|
Validators to set on this form field. |
| acl (Optional) | |
| Type |
DfFieldAcl[]
|
|
Description
|
ACL rules to be applied to this field. |
| columnSpan (Optional) | |
| Type |
number
|
|
Description
|
This field's custom size. Number of column(s) the element should span. It's only applicable with the "CUSTOM_COLUMN" layout. The value can be 1-12, following the 12-column grid system. The default value is 12. |
| id | |
| Type |
string
|
|
Description
|
This field's ID. The ID will serve as the ACL resource name for the form field. If the field is a form element, it will also be used as a form control name within the FormGroup to which it is added. IDs must be unique within your form. Example : |
| infoIcon (Optional) | |
| Type |
DfInfoIconConfig
|
|
Description
|
Info icon with associated pop-over. |
| onInitEvent (Optional) | |
| Type |
DfInteractiveEventConfig
|
|
Description
|
Configure either a PFE action or service activator configuration handler when the field's |
| renderName (Optional) | |
| Type |
string
|
|
Description
|
The optional renderName is added as the attribute "data-render-name" to the df-formfield elements in the DOM. It can be used to find the rendered element of a specific field of a form. |
| spacing (Optional) | |
| Type |
DfFormfieldSpacing
|
|
Description
|
This field's custom spacing. If defined, it will be used to set the spacing between this field and the next one. |
| testId (Optional) | |
| Type |
string
|
|
Description
|
The id used to select the element in the tests (unit test, e2e testing) |
import { DfInteractiveBaseConfig } from '@allianz/taly-core/dynamic-form';
/**
* The value to use for the `type` attribute of switcher formfield configs.
*/
export const DfSwitcherTypeName = 'SWITCHER';
/**
* Configuration for a dynamic input field.
*/
export interface DfSwitcherConfig extends DfInteractiveBaseConfig {
/**
* Specifies the type of the field as `SWITCHER`.
*/
type: typeof DfSwitcherTypeName;
/**
* 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 label position to be on the left or right. Default is left.
*/
labelPosition?: SwitcherLabelPosition;
/**
* Sets the switcher size to be small or large. Default is small.
*/
size?: SwitcherSize;
/**
* The field's initial value. `true` if toggled on, `false` if toggled off.
*/
value?: boolean;
}
export const SwitcherLabelPosition = {
Left: 'left',
Right: 'right'
} as const;
type SwitcherLabelPosition = (typeof SwitcherLabelPosition)[keyof typeof SwitcherLabelPosition];
export const SwitcherSize = {
Small: 'small',
Large: 'large'
} as const;
type SwitcherSize = (typeof SwitcherSize)[keyof typeof SwitcherSize];