@gluestack-ui/form-control

Installation

To use @gluestack-ui/form-control, all you need to do is install the @gluestack-ui/form-control package:

1$ yarn add @gluestack-ui/form-control
2
3# or
4
5$ npm i @gluestack-ui/form-control

Usage

By using FormControl, developers can provide important context to form elements. This context can include whether the element is invalid, disabled, or required. Here's an example how to use this package to create one:

1import {
2  Root,
3  Error,
4  ErrorText,
5  ErrorIcon,
6  Label,
7  LabelText,
8  LabelAstrick,
9  Helper,
10  HelperText,
11} from '../components/core/form-control/styled-components';
12import { createFormControl } from '@gluestack-ui/form-control';
13const FormControl = createFormControl({
14  Root,
15  Error,
16  ErrorText,
17  ErrorIcon,
18  Label,
19  LabelText,
20  LabelAstrick,
21  Helper,
22  HelperText,
23});

Customizing the form-control:

Default styling of all these components can be found in the components/core/form-control file. For reference, you can view the source code of the styled form-control components.

1// import the styles
2import {
3  Root,
4  Error,
5  ErrorText,
6  ErrorIcon,
7  Label,
8  LabelText,
9  LabelAstrick,
10  Helper,
11  HelperText,
12} from '../components/core/form-control/styled-components';
13
14// import the createFormControl function
15import { createFormControl } from '@gluestack-ui/form-control';
16
17// Understanding the API
18const FormControl = createFormControl({
19  Root,
20  Error,
21  ErrorText,
22  ErrorIcon,
23  Label,
24  LabelText,
25  LabelAstrick,
26  Helper,
27  HelperText,
28});
29
30// Using the FormControl component
31export default () => (
32  <FormControl>
33    <FormControlLabel>
34      <FormControlLabelText></FormControlLabelText>
35    </FormControlLabel>
36    <Input />
37    <FormControlHelper>
38      <FormControlHelperText></FormControlHelperText>
39    </FormControlHelper>
40    <FormControlError>
41      <FormControlErrorIcon>
42        <AlerCircleIcon />
43      </FormControlErrorIcon>
44      <FormControlErrorText></FormControlErrorText>
45    </FormControlError>
46  </FormControl>
47);

More guides on how to get started are available here.