File

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

Extends

DfBaseConfig

Index

Properties

Properties

cssClasses (Optional)
Type string
Description

Property to add css classes via configuration

headerOption
Type HeaderOption
Description

The nxHeadline option. This determines the visuals.

headerType
Type HeaderType
Description

The headlineType

type
Description

Specifies the type of the field as HEADLINE.

import { DfBaseConfig } from '@allianz/taly-core/dynamic-form';

/**
 * The value to use for the `type` attribute of headline
 * formfield configs.
 */
export const DfHeadlineTypeName = 'HEADLINE';

export const HeaderType = {
  h1: 'h1',
  h2: 'h2',
  h3: 'h3',
  h4: 'h4',
  h5: 'h5',
  h6: 'h6'
} as const;
export type HeaderType = (typeof HeaderType)[keyof typeof HeaderType];

export type HeaderOption =
  | 'page'
  | 'page-bold-caps'
  | 'section'
  | 'subsection-large'
  | 'subsection-medium'
  | 'subsection-small'
  | 'subsection-xsmall';

/**
 * @additionalProperties false
 */
export interface DfHeadlineConfig extends DfBaseConfig {
  /**
   * Specifies the type of the field as `HEADLINE`.
   */
  type: typeof DfHeadlineTypeName;

  /**
   * The headlineType
   */
  headerType: HeaderType;

  /**
   * The nxHeadline option. This determines the visuals.
   */
  headerOption: HeaderOption;

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

results matching ""

    No results matching ""