Skip to content

Properties

PropertyTypeDescription
visibleWhenobject(optional) Provide a path or itemPath, and a hasValue function that returns either a boolean or the expected value to determine whether the children should be shown. The first parameter passed to hasValue is the value at the given path. If the path does not exist, the value will be undefined. Alternatively, you can use isValid instead of hasValue to show the children only when the field has no validation errors and has been blurred (lost focus). You can change this behavior by setting the validateContinuously property.
visibleWhenNotobject(optional) Same as visibleWhen, but with inverted logic.
pathDefinedstring(optional) Given data context path must be defined to show children.
pathUndefinedstring(optional) Given data context path must be undefined to show children.
pathTruthystring(optional) Given data context path must be truthy to show children.
pathFalsystring(optional) Given data context path must be falsy to show children.
pathTruestring(optional) Given data context path must be true to show children.
pathFalsestring(optional) Given data context path must be false to show children.
inferDatafunction(optional) Will be called to decide by external logic, and show/hide contents based on the return value.
visibleboolean(optional) Control visibility directly using the visible prop. When used alongside other conditions, the visible prop takes precedence.
animateboolean(optional) Define if the content should animate during show/hide.
keepInDOMboolean(optional) Keep the content in the DOM, even if it's not visible. Can be used to let fields run validation.
compensateForGapstring(optional) To compensate for CSS gap between the rows, so animation does not jump during the animation. Provide a CSS unit or auto. Defaults to null.
filterDataobject
function
(optional) Filter data based on provided criteria. More info about filterData can be found in the Getting Started documentation.
fieldPropsWhenHiddenvarious(optional) When visibility is hidden, and keepInDOM is true, pass these props to the children.
elementstring or React.Element(optional) Define the type of element. Defaults to div. Only for when animate is true.
childrenReact.Node(required) Contents.