TALY - The Allianz Library
  1. Interfaces
  2. DfTextAreaConfig

File

libs/core/dynamic-form/text-area/src/text-area.model.ts

Description

Definition of text area

Extends

DfInteractiveBaseConfig,SingleInputFieldLayout

Index

Properties

Properties

autosize (Optional)
Type boolean
Default value true
Description

Property that allow the component to auto-size when the are more written lines than rows. true
label
Type string
Description

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

Example :
maxLength (Optional)
Type number
Description

The maximum number of characters allowed in the <input> element.
optionalLabel (Optional)
Type string
Description

Text that is additionally displayed in the label if the field is not mandatory.

Example :
rows (Optional)
Type number
Default value 2
Description

Number of visible text lines for the control. 2
type
Type typeof DfTextAreaTypeName
Description

Specifies the type of the field as TEXT_AREA.
value (Optional)
Type string
Description

The field's initial value.

Example :
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 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, SingleInputFieldLayout } from '@allianz/taly-core/dynamic-form';

/**
 * Definition of the type - dynamic text area
 */
export const DfTextAreaTypeName = 'TEXT_AREA';

/**
 * Definition of text area
 */
export interface DfTextAreaConfig extends DfInteractiveBaseConfig, SingleInputFieldLayout {
  /**
   * Specifies the type of the field as `TEXT_AREA`.
   */
  type: typeof DfTextAreaTypeName;

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

  /**
   * Number of visible text lines for the control.
   * @default 2
   */
  rows?: number;

  /**
   * Property that allow the component to auto-size when the are more written lines than rows.
   * @default true
   */
  autosize?: boolean;

  /**
   * The maximum number of characters allowed in the `<input>` element.
   */
  maxLength?: number;

  /**
   * Text that is additionally displayed in the label if the field is not mandatory.
   * @examples ["Optional"]
   */
  optionalLabel?: string;

  /**
   * The field's initial value.
   * @examples ["Some pre-filled text"]
   */
  value?: string;
}

results matching ""

    No results matching ""