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

# Border beam

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

<PharenUiPreview name="border-beam" title="Border beam preview" />

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

  <template>
    <div class="relative w-full max-w-sm overflow-hidden rounded-xl border bg-card p-6 shadow-sm">
      <BorderBeam :duration="7" />
      <p class="text-sm font-semibold">Live workflow</p>
      <p class="mt-1 text-sm text-muted-foreground">The animated beam follows the surface border.</p>
    </div>
  </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 { BorderBeam } from '@pharen/ui';
```

## Exports

| Export       | Purpose                                  |
| ------------ | ---------------------------------------- |
| `BorderBeam` | 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/BorderBeam.vue)