# Tree Select

> A checkbox tree in a popover for picking teams, folders or regions. Checking a parent checks its branch, partly picked parents show a dash and a count, and search keeps matching branches open while dimming the rest. The trigger sums up the pick as chips with +N, and checkStrategy reports full branches as the parent, the leaves or both. Real tree roles and keys, including type-ahead.

- Slug: `tree-select`
- Category: [Selects](https://www.assembli.design/category/selects.md)
- Type: component
- Tags: tree, select, checkbox, hierarchy, multi-select, folders, teams, keyboard
- npm dependencies: @base-ui/react, lucide-react
- shadcn/ui dependencies: none
- Live preview: https://www.assembli.design/preview/tree-select
- Page: https://www.assembli.design/components/tree-select

![Tree Select preview](https://www.assembli.design/thumbnails/tree-select-light.png)

## Props

Other props pass through to the root element.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `nodes` (required) | `TreeSelectNode[]` |  |  |
| `value` | `string[]` |  |  |
| `defaultValue` | `string[]` |  |  |
| `onValueChange` | `(value: string[], nodes: TreeSelectNode[]) => void` |  |  |
| `checkStrategy` | `TreeCheckStrategy` | `"parent"` | Defaults to `parent`. |
| `defaultExpanded` | `string[] \| "all"` |  | Branches open when the popup first opens, or `"all"`. |
| `label` | `React.ReactNode` |  |  |
| `hint` | `React.ReactNode` |  |  |
| `description` | `React.ReactNode` |  |  |
| `error` | `React.ReactNode` |  | Replaces the description and marks the trigger `aria-invalid`. |
| `placeholder` | `React.ReactNode` | `"Select…"` |  |
| `searchPlaceholder` | `string` | `"Search…"` |  |
| `showSearch` | `boolean` | `true` | Shows a search field above the tree. Defaults to true. |
| `maxChips` | `number` | `2` | Chips shown in the trigger before "+N". Defaults to 2. |
| `disabled` | `boolean` |  |  |
| `required` | `boolean` |  |  |
| `name` | `string` |  | Submits every value with a surrounding form. |
| `open` | `boolean` |  |  |
| `defaultOpen` | `boolean` | `false` |  |
| `onOpenChange` | `(open: boolean) => void` |  |  |

## Install

One-time setup (needs a subscription):

1. Add the registry to the project's `components.json`: `{"@assembli":{"url":"https://www.assembli.design/r/{name}.json","headers":{"Authorization":"Bearer ${ASSEMBLI_API_KEY}"}}}` (merge into `"registries"`).
2. Put an API key from https://www.assembli.design/account in `.env.local` as `ASSEMBLI_API_KEY=asm_…`.

Then install with the shadcn CLI (writes `components/tree-select/tree-select.tsx` and installs dependencies):

```bash
npx shadcn@latest add @assembli/tree-select
```

Registry item JSON: https://www.assembli.design/r/tree-select.json (send `Authorization: Bearer <api key>`)

## Code

> Component source needs an Assembli subscription ($12/month or $96/year) and an API key sent as `Authorization: Bearer <key>`. To get one without copying anything, POST https://www.assembli.design/api/agent/login (or call the MCP tool connect_account), show the user the link it returns, and poll https://www.assembli.design/api/agent/token for the key. Or subscribe at https://www.assembli.design/pricing and create a key at https://www.assembli.design/account.