File size: 2,068 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
---
title: Field
description: Used to add labels, help text, and error messages to form fields.
links:
source: components/field
storybook: components-field--basic
recipe: field
ark: https://ark-ui.com/react/docs/components/field
---
<ExampleTabs name="field-basic" />
## Usage
```tsx
import { Field } from "@chakra-ui/react"
```
```tsx
<Field.Root>
<Field.Label>
<Field.RequiredIndicator />
</Field.Label>
<Input />
<Field.HelperText />
<Field.ErrorText />
</Field.Root>
```
:::info
If you prefer a closed component composition, check out the
[snippet below](#closed-component).
:::
## Examples
### Error Text
Pass the `invalid` prop to `Field.Root` and use the `Field.ErrorText` to
indicate that the field is invalid.
<ExampleTabs name="field-with-error-text" />
### Helper Text
Use the `Field.HelperText` to add helper text to the field.
<ExampleTabs name="field-with-helper-text" />
### Horizontal
Use the `orientation="horizontal"` prop to align the label and input
horizontally.
<ExampleTabs name="field-horizontal" />
### Disabled
Use the `disabled` prop to disable the field.
<ExampleTabs name="field-with-disabled" />
### Textarea
Here's how to use the field component with a textarea.
<ExampleTabs name="field-with-textarea" />
### Native Select
Here's how to use the field component with a native select.
<ExampleTabs name="field-with-native-select" />
### Required
Pass the `required` prop to `Field.Root` and use the `Field.RequiredIndicator`
to indicate that the field is required.
<ExampleTabs name="field-with-required" />
### Optional
Pass the `fallback` prop to the `Field.RequiredIndicator` to add optional text.
<ExampleTabs name="field-with-optional" />
### Closed Component
Here's how to setup the Field for a closed component composition.
<ExampleCode name="field-closed-component" />
If you want to automatically add the closed component to your project, run the
command:
```bash
npx @chakra-ui/cli snippet add field
```
## Props
### Root
<PropTable component="Field" part="Root" />
|