@harmonyorg/importer-js v0.12.0

@rowslint/importer-js

The Rowslint JavaScript script provides access to the prebuilt importer component. The package interacts directly with the Rowslint APIs using your API key.

Usage

Call the launch() method with the organizatio API key and the template key parameters to display the importer UI.

<button onclick="launch()">Launch</button>

<script src="https://cdn.jsdelivr.net/npm/@rowslint/importer-js/dist/rowslint.js"></script>
<script>
  function launch() {
    rowslint.launch({
      // Your organization API key here.
      apiKey: "ORGANIZATION_API_KEY",
      config: {
        // Your template key here.
        templateKey: "TEMPLATE_KEY"
      }
    });
  }
</script>

Headless UI

You can also use your custom upload UI and then use Rowslint importer only to format and validate data. To do so, call the launch() method with the uploaded file (in file type).

rowslint.launch({
  apiKey: 'ORGANIZATION_API_KEY',
  config: {
    templateKey: 'TEMPLATE_KEY',
    // `currentFile` in `file` type.
    file: currentFile,
  },
});

Events

The launch() method provide a callback parameter which is triggered on the importer closes. You can use it to handle the closing of the importer after the import has been completed.

rowslint.launch({
  apiKey: 'ORGANIZATION_API_KEY',
  config: { templateKey: 'TEMPLATE_KEY' },
  onImport: (result) => {
    switch (result.status) {
      case 'success':
        // Handle spreadsheet import success.
        break;
      case 'error':
        // Handle spreadsheet import error.
        break;
      case 'cancelled':
        // Handle spreadsheet import cancel.
        break;
    }
  },
});