Optional childrenIf the field widget accepts the children, then you can specify it by this.
Optional clearIn the grid layout system, if the field allows other fields in left, right or both
position. For example, if clear is right, then no other fields in the right even
there's still space (by columns).
Optional colNice form provides the grid layout system, colSpan is used to specify how many columns of the field.
Optional conditionA function returns true or false to determine if the field should be rendered. It's convenient to show/hide fields dynamically.
If you need complex logic, you can modify meta fields directlly after meta is constructed.
Optional disabledWhether the field is disabled.
Optional extraThe extra node of the field. Appended just after the field component. You usually need to use css to position it.
Optional fullWhether the field is full width of the space.
Optional helpHelp information of the field, consumed by adapter.
Optional initialThe initial value of the field.
The field key. It's used to identify the field. It's used as the field name if the name is not defined. In this case, the name is generated by splitting the key by '.'. For example: if the key is 'user.name', the name will be ['user', 'name']. So it's convenient to support nested object.
Note: if you want a dot . to be part of the field name, you should specify the name explicitly.
For example: name: ['user', 'name.with.dot']
Optional labelThe label of the field, adapters should implement the support for labels.
Optional labelThe label width.
The name of the field, its format may be different for different adapters. For example, in antd, it's an array of path. See API doc of the library you use.
Optional optionsOnly for field widget which consumes a list data. For example: select, checkbox group, radio group, etc.
Optional renderYou can use render method to render any content of the field in both edit and view mode. It will replaces
the logic provided by adapters. You need to handle the edit/view mode in the function.
Optional renderYou can use renderView method to render the widget (without label).
Optional requiredWhether the field is required.
Optional rowNice form provides the grid layout system, colSpan is used to specify how many rows of the field.
Optional viewIf the field is in view mode, it will use viewWidget to render the field. Note that this is different with readOnly property which passes readOnly to the field component.
The widget component or widget id in view mode.
Optional viewThe view mode widget component props.
The widget component or widget id in edit mode.
Optional widgetThe edit mode widget component props.
Optional widgetThe widget type.
Generated using TypeDoc
This is normalized form field meta for internal usage. Usually not used by end users. It ensures the meta always has name/widget/viewWidget defined.