angular5-csv

Helper library for create CSV file in Angular 5

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
angular5-csv
46190.2.115 years ago6 years agoMinified + gzip package size for angular5-csv in KB

Readme

angularjs_logo
Angular5-csv | Export to CSV in Angular5
Codacy Badge Build Status npm version GitHub license Angular npm
Helper library for create CSV file in Angular5

Installation


npm install --save angular5-csv

Example

import { Angular5Csv } from 'angular5-csv/Angular5-csv';

var data = [
  {
    name: "Test 1",
    age: 13,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
  {
    name: 'Test 2',
    age: 11,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
  {
    name: 'Test 4',
    age: 10,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
];

new Angular5Csv(data, 'My Report');

API | Angular5Csv(data, filename, options)

| Option | Default | Description | | :------------- |:-------------:| -----| | fieldSeparator | , | Defines the field separator character | | quoteStrings | " | If provided, will use this characters to "escape" fields, otherwise will use double quotes as deafult | | decimalseparator | . | Defines the decimal separator character (default is .). If set to "locale", it uses the language sensitive representation of the number.| | showLabels | false | If provided, would use this attribute to create a header row | | showTitle | false | | | useBom | true | If true, adds a BOM character at the start of the CSV | | noDownload | false | If true, disables automatic download and returns only formatted CSV | | nullToEmptyString | false | If true, all null values will be changed to empty strings |

Options Example

var options = { 
  fieldSeparator: ',',
  quoteStrings: '"',
  decimalseparator: '.',
  showLabels: true, 
  showTitle: true,
  title: 'Your title',
  useBom: true,
  noDownload: true,
  headers: ["First Name", "Last Name", "ID"],
  nullToEmptyString: true,
};

Angular5Csv(data, filename, options);

Credits

sn123 arf1980 rob-moore