# Bullet List

Nested structured content with ●/└/□ bullet prefixes



<ComponentPreview base="ink" name="bullet-list-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/bullet-list
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="ink" name="bullet-list" title="components/ui/bullet-list.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { BulletList } from "@/components/ui/bullet-list";
```

```tsx
<BulletList>
  <BulletList.Item label="Install dependencies" bold>
    <BulletList.Sub>
      <BulletList.TreeItem label="ink@5.1.0" />
      <BulletList.TreeItem label="react@18.3.0" />
    </BulletList.Sub>
  </BulletList.Item>
  <BulletList.Item label="Configure project" />
  <BulletList.CheckItem label="Write tests" done />
  <BulletList.CheckItem label="Deploy to production" />
</BulletList>
```

API Reference [#api-reference]

BulletList [#bulletlist]

| Prop       | Type        | Default    |
| ---------- | ----------- | ---------- |
| `children` | `ReactNode` | `required` |

BulletList.Item [#bulletlistitem]

| Prop       | Type        | Default    |
| ---------- | ----------- | ---------- |
| `label`    | `string`    | `required` |
| `bold`     | `boolean`   | `false`    |
| `color`    | `string`    | -          |
| `children` | `ReactNode` | -          |

BulletList.Sub [#bulletlistsub]

| Prop       | Type        | Default    |
| ---------- | ----------- | ---------- |
| `children` | `ReactNode` | `required` |

BulletList.TreeItem [#bulletlisttreeitem]

| Prop    | Type     | Default    |
| ------- | -------- | ---------- |
| `label` | `string` | `required` |
| `color` | `string` | -          |

BulletList.CheckItem [#bulletlistcheckitem]

| Prop    | Type      | Default    |
| ------- | --------- | ---------- |
| `label` | `string`  | `required` |
| `done`  | `boolean` | `false`    |
| `color` | `string`  | -          |