lhanscom / ngx-csv

Helper library for create CSV file in Angular 7
MIT License
4 stars 5 forks source link

angularjs_logo

ngx-csv | Export to CSV in ngx

npm version Angular npm

Helper library for create CSV file in Angular2+

Installation

npm install --save ngx-csv

Example


import { ngxCsv } from 'ngx-csv/ngx-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 ngxCsv(data, 'My Report');

API | ngxCsv(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
removeEmptyValues false If true, null and undefined values will be be removed instead of being wrapped in ""
eol \r\n Defines the End Of Line character Escape secuence

Options Example

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

  ngxCsv(data, filename, options);

Credits