Parameters
Properties passed to the useValueProps hook.
| Type | Description | |
|---|---|---|
value | string | (optional) Direct value to display. Takes precedence over path-based data from DataContext. |
defaultValue | string | (optional) Default value when no value is available from DataContext or value prop. |
path | string | (optional) JSON Pointer to the data location in DataContext. Links this Value component to its data source. |
itemPath | string | (optional) Path relative to the current Iterate element. Used when inside an Iterate context. |
label | React.ReactNode | (optional) Label to display with the value. Can be inherited from the associated Field component. |
inheritLabel | boolean | (optional) When true, inherits the label from the Field component at the same path. |
inheritVisibility | boolean | (optional) When true, inherits visibility state from the Field component at the same path. |
transformIn | (external: Value) => Value | (optional) Transforms the external value before processing. Receives the raw data value. |
toInput | (value: Value) => Value | (optional) Transforms the internal value for display (after transformIn). |
fromExternal | (value: Value) => Value | (optional) Transforms value when reading from external data sources. |
Return Values
Properties returned from the useValueProps hook (in addition to all input props).
| Type | Description | |
|---|---|---|
...props | object | (required) All input props are passed through in the return value. |
value | string undefined | (optional) The transformed value ready for display, or undefined if the associated field is not visible. |
label | React.ReactNode | (optional) The label to display, either from props or inherited from the associated Field. |