# CSV Import (/docs/components/csv-import)



<ComponentPreview name="csv-import" />

## Installation [#installation]

<Tabs items="[&#x22;Command&#x22;, &#x22;Manual&#x22;]">
  <Tab value="Command">
    <CodeBlockTabs defaultValue="npm">
      <CodeBlockTabsList>
        <CodeBlockTabsTrigger value="npm">
          npm
        </CodeBlockTabsTrigger>

        <CodeBlockTabsTrigger value="pnpm">
          pnpm
        </CodeBlockTabsTrigger>

        <CodeBlockTabsTrigger value="yarn">
          yarn
        </CodeBlockTabsTrigger>

        <CodeBlockTabsTrigger value="bun">
          bun
        </CodeBlockTabsTrigger>
      </CodeBlockTabsList>

      <CodeBlockTab value="npm">
        ```bash
        npx shadcn@latest add @uploadcn/csv-import
        ```
      </CodeBlockTab>

      <CodeBlockTab value="pnpm">
        ```bash
        pnpm dlx shadcn@latest add @uploadcn/csv-import
        ```
      </CodeBlockTab>

      <CodeBlockTab value="yarn">
        ```bash
        yarn dlx shadcn@latest add @uploadcn/csv-import
        ```
      </CodeBlockTab>

      <CodeBlockTab value="bun">
        ```bash
        bun x shadcn@latest add @uploadcn/csv-import
        ```
      </CodeBlockTab>
    </CodeBlockTabs>
  </Tab>

  <Tab value="Manual">
    Install [Upload](/docs/components/upload) and the shadcn `badge`, `button`, `table` components, then copy:

    <ComponentSource name="csv-import" />
  </Tab>
</Tabs>

## Usage [#usage]

```tsx
import { CsvImport } from "@/components/csv-import"
```

```tsx
<CsvImport
  columns={[
    { key: "email", label: "Email", required: true },
    { key: "name", label: "Name" },
  ]}
  onSuccess={(item, preview) => startImportJob(item.result, preview.rowCount)}
/>
```

Uploading only starts when the user clicks **Import**, and stays disabled while required columns are missing. Parsing is a small RFC 4180 parser, swap in Papa Parse for exotic files.

## Props [#props]

<TypeTable
  type="{
  adapter: {
    type: &#x22;UploadAdapter&#x22;,
    default: 's3Adapter({ endpoint: &#x22;/api/upload&#x22; })',
    description: &#x22;Where files go.&#x22;,
  },
  uploader: {
    type: &#x22;Uploader&#x22;,
    description: &#x22;An uploader from `useUploader`, instead of options.&#x22;,
  },
  columns: {
    type: &#x22;CsvColumn[]&#x22;,
    default: &#x22;a product catalog&#x22;,
    description:
      &#x22;`{ key, label?, required? }`. Headers match case- and space-insensitively.&#x22;,
  },
  maxSize: { type: &#x22;number&#x22;, default: &#x22;50 MB&#x22; },
  onSuccess: { type: &#x22;(item, preview) => void&#x22; },
  className: { type: &#x22;string&#x22; },
}"
/>