Skip to main content

Getting Started

Let's integrate the UseCSV Importer plugin with your React app.

Make sure you configured your importer before starting.

Install

Using NPM
npm install @usecsv/react
Using YARN
yarn add @usecsv/react

Add the Importer

Adding the UseCSV component to your frontend will render a button that triggers the import modal when clicked.

Additional metadata can be passed in the user prop, and this will be passed back to your app in the JSON webhook when data is imported. It's a good idea to include a userId or similar identifying data, so you can correctly identfiy and import the data into your app. Check more details about Options.

  • importerKey: string Which can be found in the admin panel.

  • user: json object Contains details of the importing user, so that they can be identified easily.

Code example with default button

import UseCSV from "@usecsv/react";

const App = () => {
return (
<div>
<h1>Start importing your data</h1>
<UseCSV importerKey="your-importer-key" user={{ userId: "12345" }}>
Import Data
</UseCSV>
</div>
);
};

export default App;

The component contents will be used as the button text.

Usage Exmaple

Code example with custom render prop

More details can be found in render prop

import UseCSV from "@usecsv/react";

function App() {
const renderButton = (openModal) => {
return (
<button
onClick={openModal}
style={{
width: "170px",
height: "70px",
color: "#fff",
backgroundColor: "#027ad6",
boxShadow: "0 32px 64px rgba(0,0,0,0.07);",
font: "700 24px sans-serif",
textAlign: "center",
border: "none",
borderRadius: "3px",
}}
>
Import Data
</button>
);
};
return (
<div className="App">
<UseCSV
importerKey="your-importer-key"
user={{ userId: 12345 }}
render={(openModal) => renderButton(openModal)}
/>
</div>
);
}

export default App;
Usage example with render

Now your users can import data from within your app, the final step is to setup a webhook in your backend to receive imports. Let's goto the Webhook docs.