| Type parameter | Description |
|---|---|
| TInputs: InputGroupContent |
Instantiates an input group
The structure of inputs. This maybe a single input, an object of inputs or input groups, an array of inputs or input groups, or a nested structure thereof, or a function returning such a structure.
Customizes input group behavior.
Development-time settings
Customizes input group behavior.
Returns an array of the input group's structural items. Unlike [[flattenedInputs]], the subgroups are not broken down into inputs here.
Same as with value but each value is the current input value, not the
confirmed input value.
Reflects the structure of inputs as provided in the constructor. If a function was passed in the constructor, it is evaluated here. Subgroups in the structures are collapsed into their structures.
Use structure if you need the subgroups preserved. Use [[flattenedInputs]] if you don't care about the structure and just want the inputs in an array.
Returns the UI state's debug name.
Same as with value but each value is the current input value, normalized
by each input's normalizer.
Returns the structure of the input group. If the input structure contains subgroups, the subgroups are preserved here.
Use inputs to get the input structure without subgroups.
Use [[flattenedInputs]] to get an array of inputs whose order does not matter.
Returns a structure of confirmed input value that corresponds to the input structure
passed to the constructor. For instance, if the constructor was instantiated
with { a : someInput, b: someOuterInput }, the value here will also have the
keys a and b whose value are the respective input values.
Batch-confirm the inputs using the value that is provided in the group. Note that unlike individually confirming an input, this does not permit an option to advance the focus to the "next" input.
Batch-reset the inputs using the value that is provided in the group. This is the same as calling reset on the individual input instances.
Generated using TypeDoc
Represents any arbitrary structural grouping of inputs.
This is the base for validator state (which can validate multiple inputs) and forms (whose action can depend on several inputs).