useFieldSetTabularHeaderProps
Overview
Returns computed header props (label, help, required, invalid, readOnly) for a field in tabular form mode.
Signature
useFieldSetTabularHeaderProps(formModel, formContext, formModelName, fieldValuePath)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| formModel | object | yes | The form model's reactive state. |
| formContext | FormContext | yes | The form context object. |
| formModelName | string | Ref | yes | The full FormModel name of the field. |
| fieldValuePath | string | Ref | yes | The field value path. |
formModel Properties
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| app | string | The app name to load form configuration for | ||
| baseFieldNames | ReadonlySet | The field names that are not expanded. | ||
| expand | typeOperator | The fields to expand, either passed in or from config. | ||
| expandDetails | object | The merged expandDetails, either passed in, from config or from server info. | ||
| expandedFieldNames | ReadonlySet | The field names that are expanded and base. | ||
| expansionFieldNames | ReadonlySet | The field names that are expanded. | ||
| fieldComponents | object | The field components to use, either passed in or as a result of fieldObject or expandObject. | ||
| fieldDetails | object | The merged fieldDetails, either passed in, from config or from server info. | ||
| fields | typeOperator | The fields to display, either passed in or from config. | ||
| model | string | The model name to load form configuration for | ||
| view | string | The view name if wanting to use view specific configuration. | ||
| widgetComponents | object | The widget components to use, either passed in or as a result of fieldObject or expandObject. |
Returns
ComputedRef
- The field header props.
Source
client/lib/use/useFieldSetTabularHeaderProps.js:28