> For the complete documentation index, see [llms.txt](https://docs.frayme.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frayme.ai/components/components/data/board-column.md).

# BoardColumn

One kanban column: a header (title + optional count badge) over a vertical stack of KanbanCard children. Set `collapsible` to make the header a button that collapses the body, `columnBg` to recolor the lane, and `emptyText` for the no-cards placeholder. Place several inside a KanbanBoard slot. Bind `collapsed` with `{ $bindState }` so the agent (or a sibling control) can read or drive whether the column body is collapsed from spec.state.

Accepts child elements via `children` (the `default` slot).

## Example

```json
{
  "root": "board-column",
  "elements": {
    "board-column": {
      "type": "BoardColumn",
      "props": {
        "title": "In progress",
        "count": 3,
        "collapsible": true
      }
    }
  }
}
```

## Props

| Prop          | Type      | Description                                                                                                                                                                                                                                                                                                           |
| ------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `title`       | `string`  | The column header title — one short status/stage name (e.g. "In progress"). Also identifies the column in the `change` params.                                                                                                                                                                                        |
| `count`       | `number`  | Small count badge shown next to the title (e.g. how many cards). A plain count, not a visual dimension.                                                                                                                                                                                                               |
| `accent`      | `string`  | Column header accent — the title color (default the foreground token) + the rule under the header (default the border token). Names a specific brand color.                                                                                                                                                           |
| `collapsible` | `boolean` | Make the header a toggle that collapses/expands the column body (internal state — works without a binding).                                                                                                                                                                                                           |
| `collapsed`   | `boolean` | Bindable current collapsed state of the column body (distinct from `collapsible`, which merely enables the toggle). Bind this to spec.state so an external control can read or drive whether the column is collapsed; the header toggle mirrors it here. Optional — unbound, collapse still works via internal state. |
| `columnBg`    | `string`  | The column TRACK surface fill — the shell the cards sit on (default a subtle muted wash, bg-muted/40). Names a specific column background; this is the column lane, NOT the card fill (`cardBg`).                                                                                                                     |
| `emptyText`   | `string`  | Placeholder message shown in the column body when it has no cards (e.g. "No cards yet"). Omit for a bare empty column (the default). Escaped text.                                                                                                                                                                    |
| `cardBg`      | `string`  | Resting card surface (background) colour for the cards in this column (default the card token). Cascades to KanbanCard children that do not set their own.                                                                                                                                                            |
| `cardColor`   | `string`  | On-surface text colour for the cards in this column — each card title + assignee-avatar initials (default the foreground token). Pair with `cardBg`; cascades to KanbanCard children that do not set their own `color`.                                                                                               |
| `borderColor` | `string`  | Resting card border colour for the cards in this column (default the border token). Cascades to KanbanCard children that do not set their own.                                                                                                                                                                        |
| `mutedColor`  | `string`  | Secondary/muted text colour — the count badge beside the column title + the collapse caret (default the muted-foreground token).                                                                                                                                                                                      |

## Events

### change

The header was toggled while `collapsible` is on; params carry {column, collapsed} — the column title and the NEW collapsed state.

| Key     | Type      | Description                                           |
| ------- | --------- | ----------------------------------------------------- |
| `value` | `unknown` | Optional. The new value after the change.             |
| `name`  | `string`  | Optional. The control’s machine name when it has one. |

See [Events](/components/events.md) for the full payload contract.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.frayme.ai/components/components/data/board-column.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.