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

# Kanban

> Import and use the Kanban 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 **Kanban** to organize cards across workflow columns. This page covers every Vue component exported by the public module.

<PharenUiPreview name="kanban" title="Kanban preview" />

<Accordion title="View code">
  ```vue theme={null}
  <script setup lang="ts">
  import { Kanban, KanbanBoard, KanbanCard, KanbanColumn, KanbanColumnContent, KanbanHeader, KanbanItem } from '@pharen/ui';

  const columns = {
    todo: [{ id: 'brief', title: 'Write project brief' }, { id: 'research', title: 'Research competitors' }],
    done: [{ id: 'scope', title: 'Confirm scope' }],
  };
  </script>

  <template>
    <Kanban :default-value="columns" :get-item-value="item => item.id" class="w-full">
      <KanbanBoard class="sm:grid-cols-2">
        <KanbanColumn v-for="(_, key) in columns" :key="key" :value="key">
          <KanbanHeader class="capitalize">{{ key }}</KanbanHeader>
          <KanbanColumnContent :value="key" class="rounded-lg bg-muted/50 p-2">
            <template #default="{ item }"><KanbanItem :value="item.id"><KanbanCard>{{ item.title }}</KanbanCard></KanbanItem></template>
          </KanbanColumnContent>
        </KanbanColumn>
      </KanbanBoard>
    </Kanban>
  </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 { Kanban, KanbanBoard, KanbanCard, KanbanCards, KanbanHeader, KanbanProvider, KanbanColumn, KanbanColumnContent, KanbanColumnHandle, KanbanItem, KanbanItemHandle, KanbanOverlay } from '@pharen/ui';
```

## Exports

| Export                | Purpose                                  |
| --------------------- | ---------------------------------------- |
| `Kanban`              | Exported Vue component from this module. |
| `KanbanBoard`         | Exported Vue component from this module. |
| `KanbanCard`          | Exported Vue component from this module. |
| `KanbanCards`         | Exported Vue component from this module. |
| `KanbanHeader`        | Structures the header region.            |
| `KanbanProvider`      | Exported Vue component from this module. |
| `KanbanColumn`        | Exported Vue component from this module. |
| `KanbanColumnContent` | Contains the visible content.            |
| `KanbanColumnHandle`  | Exported Vue component from this module. |
| `KanbanItem`          | Represents one item.                     |
| `KanbanItemHandle`    | Exported Vue component from this module. |
| `KanbanOverlay`       | 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/kanban)