Skip to main content


The NodeJS Module can be imported from the main entrypoint or any script in the project.

The "Complete Example" creates an app that looks like the screenshots below:


iOS screenshot


Before starting this demo, manually disable telemetry. On Linux and MacOS:

rm -rf ~/.ionic/
mkdir ~/.ionic
cat <<EOF > ~/.ionic/config.json
"version": "6.20.1",
"telemetry": false,
"npmClient": "npm"
npx @capacitor/cli telemetry off

To verify telemetry was disabled:

npx @ionic/cli config get -g telemetry
npx @capacitor/cli telemetry

Integration Details


The latest version of Ionic uses CapacitorJS. These notes are for Cordova apps.


Array<Array<any>> neatly maps to a table with ngFor:

<ion-row *ngFor="let row of data">
<ion-col *ngFor="let val of row">


@ionic-native/file reads and writes files on devices.

Reading Files

readAsArrayBuffer returns ArrayBuffer objects suitable for array type:

/* read a workbook */
const ab: ArrayBuffer = await this.file.readAsArrayBuffer(url, filename);
const wb: XLSX.WorkBook =, {type: 'array'});

Writing Files

array type can be converted to blobs that can be exported with writeFile:

/* write a workbook */
const wbout: ArrayBuffer = XLSX.write(wb, { bookType: 'xlsx', type: 'array' });
let blob = new Blob([wbout], {type: 'application/octet-stream'});
this.file.writeFile(url, filename, blob, {replace: true});



This demo was tested on an Intel Mac on 2023 March 19 with Cordova. The file integration uses @ionic-native/file version 5.36.0.

The iOS simulator runs iOS 16.5 on an iPhone SE (3rd Generation).

0) Disable telemetry as noted in the warning.

Install required global dependencies:

npm i -g cordova-res @angular/cli native-run

Follow the React Native demo to ensure iOS and Android sims are ready.

1) Create a new project:

npx @ionic/cli start SheetJSIonic blank --type angular --cordova --quiet --no-git --no-link --confirm

If a prompt asks to confirm Cordova use, enter Yes to continue.

If a prompt asks about creating an Ionic account, enter N to opt out.

2) Set up Cordova:

cd SheetJSIonic
npx @ionic/cli cordova platform add ios --confirm
npx @ionic/cli cordova plugin add cordova-plugin-file
npm install --save @ionic-native/core @ionic-native/file @ionic/cordova-builders

In some test runs, the plugin add cordova-plugin-file step reported an error:

CordovaError: Could not load API for ios project

This was resolved by removing and reinstalling the ios platform:

npx @ionic/cli cordova platform rm ios
npx @ionic/cli cordova platform add ios --confirm

3) Install dependencies:

npm install --save

4) Add @ionic-native/file to the module. Differences highlighted below:

import { AppComponent } from './app.component';
import { AppRoutingModule } from './app-routing.module';

import { File } from '@ionic-native/file/ngx';

declarations: [AppComponent],
imports: [BrowserModule, IonicModule.forRoot(), AppRoutingModule],

providers: [File, { provide: RouteReuseStrategy, useClass: IonicRouteStrategy }],
bootstrap: [AppComponent],
export class AppModule {}

5) Download and replace:

curl -o src/app/home/ -L

iOS Testing

npx @ionic/cli cordova emulate ios

In some test runs, the cordova build ios --emulator step failed with error:

> cordova build ios --emulator
Could not load API for ios project

This was resolved by forcefully installing cordova-ios:

npm i --save cordova-ios