# Virtual List

Virtualized list for 10k+ items



<ComponentPreview base="opentui" name="virtual-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/opentui-virtual-list
    ```
  </TabsContent>

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

      <ComponentSource base="opentui" name="virtual-list" title="components/ui/virtual-list.tsx" />

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

Usage [#usage]

```tsx
import { VirtualList } from "@/components/ui/virtual-list";
```

```tsx
<VirtualList
  items={Array.from({ length: 1000 }, (_, i) => `Item ${i + 1}`)}
  height={10}
  renderItem={(item, index, isActive) => <Text bold={isActive}>{item}</Text>}
/>
```

API Reference [#api-reference]

VirtualList [#virtuallist]

| Prop         | Type                                                       | Default    |
| ------------ | ---------------------------------------------------------- | ---------- |
| `items`      | `T[]`                                                      | `required` |
| `renderItem` | `(item: T, index: number, isActive: boolean) => ReactNode` | `required` |
| `height`     | `number`                                                   | `required` |
| `onSelect`   | `(item: T, index: number) => void`                         | -          |
| `cursor`     | `string`                                                   | -          |
| `overscan`   | `number`                                                   | `2`        |