How to import CSV files in Nuxt.js with UseCSV
Importing CSV and Excel files is a feature everyone has to build eventually. Whilst there are a handful of CSV parser libraries out there, you're left to build the UI yourself. We're going to show you how to add CSV file import with a delightful UI to your Nuxt.js app in just a few minutes using UseCSV.
#What is UseCSV?
UseCSV is an all-in-one CSV import product that gives you a delightful CSV importer experience for your users. All you have to do is drop-in the UseCSV JS library which gives you a powerful multi-step data import modal. Imported data is returned as a frontend callback or webhook to your backend. This takes away all the headaches of building CSV import functionality in-house .
Here's a sneak peak of what the import experience will be for your users (this opens in a modal inside your app):
Here are just a few of the awesome features of UseCSV:
- Frontend libraries which add the UseCSV import button and modal to your app
- Supports CSV and all Excel formats (xlsx, xls, xlt), including legacy Excel versions
- Handles large import files
- Includes a library of common validation rules to choose from
Without further ado, let's get started!
#Setup your UseCSV account
You'll want to first grab a free UseCSV developer account. Once you've signed up and logged in, you'll see an Importer called "My First Importer" which has already been created for you.
Click the View button. Here you can configure your Importer. Note the Key field, we'll need this later on.
Head down to the Column section, where you can setup the data model for this Importer.
Click Add Column to create a new column, for example you could add a first_name column to begin with. Create as many columns as you like.
Add CSV import to your Nuxt.js app
At it's core, Nuxt.js is Vue - but in a framework format that helps you create server-rendered apps. It uses the same structure as a typical Vue.js app, with the exception of the folder structure.
To do this, we will install via
@usecsv/vuejs to an existing Nuxt.js project.
Be sure to check out the
@usecsv/vuejs docs here.
npm install @usecsv/vuejs
yarn add @usecsv/vuejs
Now all you need to do is insert the import button with a template:
There are a few things to note about the above code:
importerKeyconnects your Nuxt.js app to your data model you setup earlier.
userparam is a JSON object that is passed as an additional data point that is included in the import. This is useful for identifying the data source such as which user it came from. You may use any key-pair values here.
- By default UseCSV renders the Import Data button for you, but you can also render a custom button. Learn more in the docs here.
http://localhost:3000 and you will see the
Import Data button.
Receive data from imports
There are two ways to receive data imports. The first is via a webhook UseCSV sends to your backend. The second way is to keep the uploaded data local by passing an onData callback function to your UseCSV component.
For this tutorial, we are going to be using the onData callback method. For more information about using the webhook method, check out the documentation for it here.
You'll see in the code above we already included an onData callback function:
You can extend this function to save the data to your backend etc. Here's an example of the passed
We're ready to try your first import
Go to your localhost frontend and click on
Import Data to open the importer modal.
Upload your CSV file, match the columns and then click import.
Watch your browser console log for the onData callback.
Where to from here?
UseCSV makes it simple to add delightful CSV import to your app. There are many powerful features under the hood including themes and validation rules. Check out the docs for more info.