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;
}