Skip to content

API reference / Common / Engine types / TextFormFieldKind

Type Alias: TextFormFieldKind ​

ts
type TextFormFieldKind = 
  | {
  checkBox: {
     size: number | null;
     sizeAuto: boolean;
     default: boolean;
     checked: boolean;
  };
}
  | {
  dropDown: {
     entries: string[];
     selected: number | null;
     default: number | null;
  };
}
  | {
  textInput: {
     kind: TextFormInputKind;
     default: string | null;
     maxLength: number | null;
     format: string | null;
  };
};

The three form fields, each with the state only it has.

One enum rather than three optional children, because w:ffData's w:checkBox / w:ddList / w:textInput are mutually exclusive: a form field is exactly one of them, and the schema's choice is the truth the model should state.