How It Works

1. Embed the CSV Importer in your app with the React
or JavaScript SDK
2. Define the columns your users can import (via the template parameter)
3. Your users import their files in your app
4. Retrieve the imported data from the onComplete event

!Importer Modal

Get Started

$3

Use NPM or Yarn to install the SDK for React
or JavaScript.

NPM

``bash
npm install csv-import-react


or


npm install csv-import-js
`

Yarn

`bash
yarn add csv-import-react


or


yarn add csv-import-js
`

$3

#### Using React:
`javascript
import {useState} from "react";
import {CSVImporter} from "csv-import-react";

function MyComponent() {
const [isOpen, setIsOpen] = useState(false);

return (
<>
setIsOpen(true)}>Open CSV Importer

modalIsOpen={isOpen}
modalOnCloseTriggered={() => setIsOpen(false)}
darkMode={true}
onComplete={(data) => console.log(data)}
template={{
columns: [
{
name: "First Name",
key: "first_name",
required: true,
description: "The first name of the user",
suggested_mappings: ["First", "Name"],
},
{
name: "Age",
data_type: "number",
},
],
}}
/>

);
}
`

#### Using JavaScript:
`html




Open CSV Importer





`

SDK Reference

$3

When set to true (default value), the importer will behave as a modal with its open state controlled by modalIsOpen. When set to false, the importer will be embedded directly in your page.

$3

Only used when isModal is true: Controls the importer modal being open or closed.
\
React SDK Only: For the JavaScript SDK, use .showModal() and .closeModal() to operate the modal.

$3

Only used when isModal is true: A function called when the user clicks the close button or clicks outside of (when used with modalCloseOnOutsideClick) the importer. useState can be used to control the importer modal opening and closing.
`javascript
const [isOpen, setIsOpen] = useState(false);
`
`jsx
setIsOpen(true)}>Open CSV Importer
modalIsOpen={isOpen}
modalOnCloseTriggered={() => setIsOpen(false)}
...
/>
`

$3

Only used when isModal is true: Clicking outside the modal will call the modalOnCloseTriggered function.

$3

Configure the columns used for the import.
`jsx
template={{
columns: [
{
name: "First Name",
key: "first_name",
required: true,
description: "The first name of the user",
suggested_mappings: ["First", "Name"],
},
{
name: "Age",
data_type: "number",
},
],
}}
`

$3

Callback function that fires when a user completes an import. It returns data, an object that contains the row data, column definitions, and other information about the import.
`jsx
onComplete={(data) => console.log(data)}
`
Example data:
`json
{
"num_rows": 2,
"num_columns": 3,
"columns": [
{
"key": "age",
"name": "Age"
},
{
"key": "email",
"name": "Email"
},
{
"key": "first_name",
"name": "First Name"
}
],
"rows": [
{
"index": 0,
"values": {
"age": 23,
"email": "maria@example.com",
"first_name": "Maria"
}
},
{
"index": 1,
"values": {
"age": 32,
"email": "robert@example.com",
"first_name": "Robert"
}
}
]
}
`

$3

Toggle between dark mode (true) and light mode (false).

$3

Specifies the primary color for the importer in hex format. Use customStyles to customize the UI in more detail.
`jsx
primaryColor="#7A5EF8"
`

$3

Apply custom styles to the importer with an object containing CSS properties and values. Note that custom style properties will override primaryColor and any default styles from darkMode.
Available options:
`jsx
customStyles={{
"font-family": "cursive",
"font-size": "15px",
"base-spacing": "2rem",
"border-radius": "8px",
"color-primary": "salmon",
"color-primary-hover": "crimson",
"color-secondary": "indianRed",
"color-secondary-hover": "crimson",
"color-tertiary": "indianRed",
"color-tertiary-hover": "crimson",
"color-border": "lightCoral",
"color-text": "brown",
"color-text-soft": "rgba(165, 42, 42, .5)",
"color-text-on-primary": "#fff",
"color-text-on-secondary": "#ffffff",
"color-background": "bisque",
"color-background-modal": "blanchedAlmond",
"color-input-background": "blanchedAlmond",
"color-input-background-soft": "white",
"color-background-menu-hover": "bisque",
"color-importer-link": "indigo",
"color-progress-bar": "darkGreen"
}}
`

$3

When set to false, hide the Download Template button on the first screen of the importer.

$3

When set to true`, the importer will not display and skip the Header Row Selection step and always choose the first row in the file as the header.

Get In Touch

Let us know your feedback or feature requests! Submit a GitHub
issue here.