import { DfBaseConfig } from '@allianz/taly-core/dynamic-form';
import { IconSize } from '@aposin/ng-aquila/icon';

/**
 * The value to use for the `type` attribute of paragraph
 * formfield configs.
 */
export const DfParagraphTypeName = 'PARAGRAPH';

export interface DfParagraphConfig extends DfBaseConfig {
  /**
   * Specifies the type of the field as `PARAGRAPH`.
   */
  type: typeof DfParagraphTypeName;

  /**
   * 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 nxCopytext variant. This determines the visuals of the paragraph.
   */
  copytextOption?: 'small' | 'medium' | 'normal' | 'large';

  /**
   * Configuration of the icon to be place before the label.
   */
  icon?: IconDefinition;

  /**
   * Property to add css classes via configuration
   * @examples ["nx-font-weight-bold nx-margin-bottom-s"]
   */
  cssClasses?: string;
}

export interface IconDefinition {
  /**
   * Name of the NDBX icon.
   * Available icon names can be found in the NDBX documentation: https://ngx-ndbx.frameworks.allianz.io/documentation/icon/overview.
   * @examples ["info-circle", "exclamation-circle"]
   *
   */
  name: string;
  /**
   * Size of the icon
   */
  size: IconSize;
}