Skip to content

Repository files navigation

DolphinCSV Javascript SDK

DolphinCSV is an embeddable CSV importer designed to help your users import spreadsheet data into your product. It works out of the box and takes just 10 minutes to set up.

You can embed the DolphinCSV importer in your product by using our JavaScript SDKs. Click here if you're looking for the React SDK.

To get your Client ID, create an account.

Check out our documentation here.

If you ever get stuck or need any help, feel free to click the chat button on the bottom right of our website, and we'll assist you.

Installation

Node.js

npm install @dolphincsv/csv-importer-js -s

Browser (JavaScript)

<script src="https://cdn.jsdelivr.net/npm/@dolphincsv/csv-importer-js@latest" type="text/javascript"></script>

Usage

Node.js

import { DolphinCSVImporter } from "@dolphincsv/csv-importer-js";

var importer = DolphinCSVImporter({
    mode: 'development',
    clientId: "YOUR_CLIENT_ID",
    templateKey: "YOUR_TEMPLATE_KEY",
    iFrameClassName: '',
    columns: [
        {key: "name", label: "Name", type: "text", required: true},
        {key: "postcode", label: "postcode", type: "us_postcode", required: true},
        {key: "birthday", label: "Birthday", type: "date", required: true},
        ],
    onSuccess: (importedData) => console.dir(importedData),
    onError: (err) => console.log(err),
    onClose: () => { /* do something */ },
});

importer.launch();

Browser (JavaScript)

<script type="text/javascript">
  var importer = DolphinCSV.DolphinCSVImporter({
    mode: 'development',
    clientId: "YOUR_CLIENT_ID",
    templateKey: "YOUR_TEMPLATE_KEY",
    iFrameClassName: '',
    columns: [
      {key: "name", label: "Name", type: "text", required: true},
      {key: "postcode", label: "postcode", type: "us_postcode", required: true},
      {key: "birthday", label: "Birthday", type: "date", required: true},
    ],
    onSuccess: (importedData) => console.dir(importedData),
    onError: (err) => console.log(err),
    onClose: () => { /* do something */ },
  });

  importer.launch();
</script>

About

DolphinCSV is a hosted CSV importer with automatic column matching, data validation, and data cleaning.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages