• Official Extension
Import-Export for XLSX

README (opens in new tab)

ApostropheCMS logo

XLSX format for Import Export Module

This module improves @apostrophecms/import-export by adding the xlsx format.

Why does this specific format live in another module?

Historically because it relied on a dependency that was not hosted on NPM. It now depends on @e965/xlsx, a registry-published mirror of SheetJS Community Edition with the same API, so it installs from the npm registry like any other module. The format remains in its own module for backwards compatibility.

Requirement

@apostrophecms/import-export should be installed and instantiated.

Please refer to the module's README before continuing.

Installation

To install the module, use the command line to run this command in an Apostrophe project's root directory:

plaintext
npm install @apostrophecms/import-export-xlsx

Usage

Configure the module in the app.js file:

javascript
require('apostrophe')({ shortName: 'my-project', modules: { '@apostrophecms/import-export': {}, '@apostrophecms/import-export-xlsx': {} } });

Please note that apos is not passed to the input and output functions of the format, as they should remain agnostic of apostrophe and only deal with retrieving and writing the documents from/to the .xlsx file.