TALY - The Allianz Library
  1. Interfaces
  2. DfRadioConfig

File

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

Description

Configuration for a dynamic radiobutton group field.

Extends

Omit<DfInteractiveBaseConfig, 'hint' | 'columnSpan'>

Index

Properties

Properties

label
Type string
Description

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

Example :
layout (Optional)
Type VerticalLayout | HorizontalLayout
Description

The layout of the field.
options
Type DfOptions[] | string
Description

The options property can take one of two forms:

  1. A hardcoded array of objects for direct display in a radio group. Each object must have a label to display and a corresponding value.
  2. A string that represents an expression. This expression is used by an option provider service to dynamically fetch the radio options.
Example :
type
Type typeof DfRadioTypeName
Description

Specifies the type of the field as RADIO.
value (Optional)
Type string | number | boolean
Description

The initially selected option value. Must match the value of one of the configured options.
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 blur event.
onValueChangesEvent (Optional)
Type DfInteractiveEventConfig
Description

Configure either a PFE action or service activator configuration handler for the field's valueChanges event.
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 ngOnInit method is triggered.
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, DfOptions } from '@allianz/taly-core/dynamic-form';
import type { VerticalLayout, HorizontalLayout } from '@allianz/taly-core/dynamic-form';

/**
 * The value to use for the `type` attribute of radiobutton group
 * formfield configs.
 */
export const DfRadioTypeName = 'RADIO';

/**
 * Configuration for a dynamic radiobutton group field.
 */
export interface DfRadioConfig extends Omit<DfInteractiveBaseConfig, 'hint' | 'columnSpan'> {
  /**
   * Specifies the type of the field as `RADIO`.
   */
  type: typeof DfRadioTypeName;

  /**
   * 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;

  /**
   * The `options` property can take one of two forms:
   * 1. A hardcoded array of objects for direct display in a radio group. Each object must have a `label` to display and a corresponding `value`.
   * 2. A string that represents an expression. This expression is used by an option provider service to dynamically fetch the radio options.
   *
   * @examples [[{"label": "The first option", "value": "1"}], "$.myExpression"]
   */
  options: DfOptions[] | string;

  /**
   * The layout of the field.
   */
  layout?: VerticalLayout | HorizontalLayout;

  /**
   * The initially selected option value.
   * Must match the `value` of one of the configured options.
   */
  value?: string | number | boolean;
}

results matching ""

    No results matching ""