🍓
🍓
🍓
🍓
Tutim Docs
Search
⌃K
Comment on page

Fields & props

Array

This is a bit more sophisticated field so we created a page with more details here:
interface FieldConfig {
key: string;
type: InputType.Array;
children: { fields: FieldConfig[] };
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • children: A nested set of fields for use with InputType.Object or InputType.Array fields.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Checkbox

interface FieldConfig {
key: string;
type: InputType.Checkbox;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Custom

This is a bit more sophisticated field so we created a page with more details here:
interface FieldConfig {
key: string;
type: InputType.Custom;
Field: Field;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
options?: Option[];
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • Field: Field component
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.
  • options: (optional) An array of Option objects for use with InputType.Select, InputType.Customand InputType.Radio fields.

Date

interface FieldConfig {
key: string;
type: InputType.Date;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Json

interface FieldConfig {
key: string;
type: InputType.Json;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

MultiText

interface FieldConfig {
key: string;
type: InputType.MultiText;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Object

This is a bit more sophisticated field so we created a page with more details here:
interface FieldConfig {
key: string;
type: InputType.Object;
children: { fields: FieldConfig[] };
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • children: A nested set of fields for use with InputType.Object or InputType.Array fields.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Number

interface FieldConfig {
key: string;
type: InputType.Number;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Password

interface FieldConfig {
key: string;
type: InputType.Password;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Radio

interface FieldConfig {
key: string;
type: InputType.Radio;
options: Option[];
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • options: (optional) An array of Option objects for use with InputType.Select, InputType.Customand InputType.Radio fields.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Select

Also known as Dropdown, Dropdown menu, or Dropdown list
Select field with Tutim default visualization
interface FieldConfig {
key: string;
type: InputType.Select;
options: Option[];
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • options: (optional) An array of Option objects for use with InputType.Select, InputType.Customand InputType.Radio fields.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Switch

interface FieldConfig {
key: string;
type: InputType.Switch;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

Text

Text field with Tutim default visualization
interface FieldConfig {
key: string;
type: InputType.Text;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

TextArea

interface FieldConfig {
key: string;
type: InputType.TextArea;
label?: string;
isDisabled?: boolean;
isRequired?: boolean;
defaultValue?: any;
}
  • key: A unique identifier for the field.
  • type: The type of input to use for the field, as specified by the InputType enumeration.
  • label: (optional) The label to display for the field.
  • isDisabled: (optional) A boolean value indicating whether the field should be disabled.
  • isRequired: (optional) A boolean value indicating whether the field is required.
  • defaultValue: (optional) The default value for the field.

​

API Reference - Previous
Field Config
Next
Object
Last modified 10mo ago