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

# Plan

> Import and use the Plan 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 **Plan** to present structured product information. This page covers every Vue component exported by the public module.

<PharenUiPreview name="plan" title="Plan preview" />

<Accordion title="View code">
  ```vue theme={null}
  <script setup lang="ts">
  import { Badge, Plan, PlanAction, PlanContent, PlanDescription, PlanFooter, PlanHeader, PlanTitle, PlanTrigger } from '@pharen/ui';
  </script>

  <template>
    <Plan default-open class="w-full max-w-lg">
      <PlanHeader>
        <div><PlanTitle>Launch workflow</PlanTitle><PlanDescription>Review the execution plan before starting.</PlanDescription></div>
        <PlanAction><Badge variant="secondary">3 steps</Badge><PlanTrigger /></PlanAction>
      </PlanHeader>
      <PlanContent>
        <ol class="grid gap-2 text-sm"><li>1. Load workspace records</li><li>2. Generate the weekly summary</li><li>3. Send the result to Slack</li></ol>
      </PlanContent>
      <PlanFooter>Estimated duration: 45 seconds</PlanFooter>
    </Plan>
  </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 { Plan, PlanHeader, PlanTitle, PlanDescription, PlanAction, PlanContent, PlanFooter, PlanTrigger } from '@pharen/ui';
```

## Exports

| Export            | Purpose                                  |
| ----------------- | ---------------------------------------- |
| `Plan`            | Exported Vue component from this module. |
| `PlanHeader`      | Structures the header region.            |
| `PlanTitle`       | Renders the accessible title.            |
| `PlanDescription` | Renders supporting description.          |
| `PlanAction`      | Exported Vue component from this module. |
| `PlanContent`     | Contains the visible content.            |
| `PlanFooter`      | Structures the footer region.            |
| `PlanTrigger`     | Opens or activates the component.        |

## Source

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