Skip to content

Properties

Value-specific properties

PropertyTypeDescription
valueArray<React.ReactNode>(optional) The value to format. Can be given as children instead.
childrenReact.ReactNode(optional) The children to format.
formatIntl.ListFormatOptions(optional) Formatting options for the value when variant is text. See the Intl.ListFormat documentation.
variantol
ul
text
(optional) Defines if the value should be displayed in list format (ol, ul) or regular text format in one line. Defaults to text.
listTypea
A
i
I
1
circle
disc
square
unstyled
undefined
(optional) Defines the type of list styling used for list variants. Used together with variant ol and ul. Variant ol: a, A, i, I and 1. Variant ul: circle, disc and square. Defaults to undefined.
insideboolean(optional) Defines the position of the marker.
outsideboolean(optional) Defines the position of the marker (default).
nestedboolean(optional) Will ensure a nested structure of several lists.
innerRefReact.RefObject(optional) Send along a custom React Ref.
Spacestring
object
(optional) Spacing properties like top or bottom are supported.

General properties

PropertyTypeDescription
valueArray<string | number>(optional) Value for the value component. Will take precedence over the path value given in the data context.
defaultValueArray<string | number>(optional) Default value for the value component. Will not take precedence over the path value given in the data context.
labelstring(optional) Field label to show above the displayed value.
labelSrOnlyboolean(optional) Use true to make the label only readable by screen readers.
helpobject(optional) Provide help content for the field using title and content as a string or React.Node. Additionally, you can set open to true to display the inline help, set the breakout property to false to disable the breakout of the inline help content, or use renderAs set to dialog to render the content in a Dialog (recommended for larger amounts of content).
transformLabelfunction(optional) Transforms the label before it gets displayed. Receives the label as the first parameter. The second parameter is a object containing the convertJsxToString function.
inheritLabelboolean(optional) Use true to inherit the label from a visible (rendered) field with the same path.
inheritVisibilityboolean(optional) Use true to inherit the visibility from a field with the same path. You can find more info in the Value section.
showEmptyboolean(optional) Shows the value even if it is empty.
placeholderstring(optional) Text showing in place of the value if no value is given.
pathstring(optional) JSON Pointer for where the data for this input is located in the source dataset.
inlineboolean(optional) For showing the value inline (not as a block element).
maxWidthstring(optional) Use auto for no max-width (use browser default), small, medium or large for predefined standard max widths. Defaults to large.
transformInfunction(optional) Transforms the value before its displayed in the value component.
Spacestring
object
(optional) Spacing properties like top or bottom are supported.