> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pharen.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Form

> Import and use the Form components from @pharen/ui.

export const PharenUiPreview = ({name, title = 'Pharen UI component preview'}) => <div className="not-prose my-6 overflow-hidden rounded-xl border border-gray-200 bg-white shadow-sm dark:border-white/10 dark:bg-zinc-950">
    <div className="pharen-ui-preview-root" data-pharen-ui-preview data-example={name} role="region" aria-label={title} />
  </div>;

Use **Form** to collect and edit a value. This page covers every Vue component exported by the public module.

<PharenUiPreview name="form" title="Form preview" />

<Accordion title="View code">
  ```vue theme={null}
  <script setup lang="ts">
  import { Form, FormControl, FormDescription, FormField, FormItem, FormLabel, FormMessage, Input } from '@pharen/ui';
  </script>

  <template>
    <Form class="w-full max-w-sm">
      <FormField v-slot="{ componentField }" name="email">
        <FormItem>
          <FormLabel>Email address</FormLabel>
          <FormControl><Input type="email" placeholder="you@company.com" v-bind="componentField" /></FormControl>
          <FormDescription>We use this address for account notifications.</FormDescription>
          <FormMessage />
        </FormItem>
      </FormField>
    </Form>
  </template>
  ```
</Accordion>

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npm install @pharen/ui
  ```

  ```bash pnpm theme={null}
  pnpm add @pharen/ui
  ```

  ```bash yarn theme={null}
  yarn add @pharen/ui
  ```

  ```bash bun theme={null}
  bun add @pharen/ui
  ```
</CodeGroup>

<Note>
  Import `@pharen/ui/styles.css` exactly once in your application entrypoint.
</Note>

## Usage

```ts theme={null}
import { FormControl, FormDescription, FormItem, FormLabel, FormMessage, Form, FormField } from '@pharen/ui';
```

## Exports

| Export            | Purpose                                  |
| ----------------- | ---------------------------------------- |
| `FormControl`     | Exported Vue component from this module. |
| `FormDescription` | Renders supporting description.          |
| `FormItem`        | Represents one item.                     |
| `FormLabel`       | Labels a value or region.                |
| `FormMessage`     | Exported Vue component from this module. |
| `Form`            | Exported Vue component from this module. |
| `FormField`       | Exported Vue component from this module. |

## Source

[Open the source on GitHub](https://github.com/PharenIT/ELEV8-Labs/tree/main/src/packages/ui/src/components/form)