> ## 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.

# Field

> Import and use the Field 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 **Field** to collect and edit a value. This page covers every Vue component exported by the public module.

<PharenUiPreview name="field" title="Field preview" />

<Accordion title="View code">
  ```vue theme={null}
  <script setup lang="ts">
  import { Field, FieldDescription, FieldLabel, Input } from '@pharen/ui';
  </script>

  <template>
    <Field class="w-full max-w-sm">
      <FieldLabel for="workspace-name">Workspace name</FieldLabel>
      <Input id="workspace-name" value="Pharen" />
      <FieldDescription>This name is visible to every workspace member.</FieldDescription>
    </Field>
  </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 { Field, FieldContent, FieldDescription, FieldError, FieldGroup, FieldLabel, FieldLegend, FieldSeparator, FieldSet, FieldTitle } from '@pharen/ui';
```

## Exports

| Export             | Purpose                                  |
| ------------------ | ---------------------------------------- |
| `Field`            | Exported Vue component from this module. |
| `FieldContent`     | Contains the visible content.            |
| `FieldDescription` | Renders supporting description.          |
| `FieldError`       | Exported Vue component from this module. |
| `FieldGroup`       | Groups related items.                    |
| `FieldLabel`       | Labels a value or region.                |
| `FieldLegend`      | Exported Vue component from this module. |
| `FieldSeparator`   | Separates adjacent regions.              |
| `FieldSet`         | Exported Vue component from this module. |
| `FieldTitle`       | Renders the accessible title.            |

## Source

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