Flatfile.com CSV Importer Adapter


A simple adapter for elegantly importing data (CSV, XLS & more) via flatfile.com (Typescript, ES6, Browser)

_Important note:_ While the below info is a basic way to get up and running, we recommend reading the developer docs → https://flatfile.com/developers/javascript/getting-started

_Another note:_ If you are using Angular or React, we have specific packages for those. Check out our React package on GitHub and Angular package on GitHub.

> License Key
>
> In order to setup, you need to create or sign in to your flatfile.com account and obtain a license key.

#### Changelog

To view information about the latest releases and any minor/major changes, check out the changelog here.

> Note: In version 2.8, previously available "deep-imports" (for Interfaces) have been moved to the root level of @flatfile/adapter.

Using NPM

If you don't like external dependencies, or you have a nice build system like Webpack in place. You can install and use Flatfile as an npm package.

``sh
npm i @flatfile/adapter --save
`

Using CDN

The latest version of the package is available via CDN so you can just drop it into your website and start using it.

`sh
https://unpkg.com/@flatfile/adapter/build/dist/index.min.js
`

Quickstart

`html



`

ES6 / Babel

`js
const LICENSE_KEY = '00000000-0000-0000-0000-000000000000' // replace this with your license key

const importer = new FlatfileImporter(LICENSE_KEY, {
type: 'Robot',
fields: [
{
label: 'Name',
key: 'name'
}
]
})

// More info: https://flatfile.com/developers/javascript/getting-started/#the-basics
importer.setCustomer({
userId: '1'
})

document.querySelector('button').addEventListener('click', async () => {
try{
const results = await importer.requestDataFromUser()

importer.displayLoader('Please wait while your data is loading')

// do something with your data
setTimeout(() => {
// console.log(results)

importer.displaySuccess('You are all done!')
}, 1000)
}catch(e){
// handle a failed upload
}
})
`

Data hooks

`js
const importer = new FlatfileImporter(LICENSE_KEY, {
type: 'Robot',
fields: [
{
label: 'Name',
key: 'name'
}
]
})

importer.setCustomer({
userId: '1'
})

// adding a data hook that will add 'Jr.' to the name in each row
importer.registerRecordHook((row) => {
// Example row: {name: 'John'}
const result = {};

if (row.name) {
result.name = {
value: ${row.name} Jr.
};
}

return result;
});
`

Themes

`js
const importer = new FlatfileImporter(LICENSE_KEY, {
type: 'Robot',
fields: [
{
label: 'Name',
key: 'name'
}
],
theme: {
global: {
backgroundColor: '#212327',
textColor: '#c2c3c3',
primaryTextColor: '#c2c3c3',
secondaryTextColor: '#c2c3c3',
successColor: '#c2c3c3',
warningColor: '#c2c3c3'
},
// other keys below
}
})
`

Promise Overrides

`js
FlatfileImporter.Promise = Bluebird.Promise
``