form
v0.88.2arrow_drop_down



























A Form displays a set of related user input fields in a structured way.
Sugar for <Form.Field control={Button} />.
Sugar for <Form.Field control={Checkbox} />.
Sugar for <Form.Field control={Dropdown} />.
A form control component (i.e. Dropdown) or HTML tagName (i.e. ‘input’). Extra FormField props are passed to the control component. Mutually exclusive with children.
A field is a form element containing a label and an input.
A form control component (i.e. Dropdown) or HTML tagName (i.e. ‘input’). Extra FormField props are passed to the control component. Mutually exclusive with children.
A set of fields can appear grouped together.
Sugar for <Form.Field control={Input} />.
Sugar for <Form.Field control={Radio} />.
Sugar for <Form.Field control={Select} />.
Sugar for <Form.Field control={TextArea} />.
Name | Type | Default value | Description |
---|---|---|---|
as | elementType | FormField | An element type to render as (string or function). |
control | custom | Button | A FormField control prop. |
as | elementType | FormField | An element type to render as (string or function). |
control | custom | Checkbox | A FormField control prop. |
as | elementType | FormField | An element type to render as (string or function). |
control | custom | Dropdown | A FormField control prop. |
as | elementType | An element type to render as (string or function). | |
children | node | Primary content. | |
className | string | Additional classes. | |
grouped | custom | Fields can show related choices. | |
inline | custom | Multiple fields may be inline in a row. | |
unstackable | bool | A form group can prevent itself from stacking on mobile. | |
widths | ...SUI.WIDTHS | 'equal' | Fields Groups can specify their width in grid columns or automatically divide fields to be equal width. | |
as | elementType | FormField | An element type to render as (string or function). |
control | custom | Input | A FormField control prop. |
as | elementType | FormField | An element type to render as (string or function). |
control | custom | Radio | A FormField control prop. |
as | elementType | FormField | An element type to render as (string or function). |
control | custom | Select | A FormField control prop. |
options (required) | {}[] | Array of Dropdown.Item props e.g. | |
as | elementType | FormField | An element type to render as (string or function). |
control | custom | TextArea | A FormField control prop. |