0.3.2 • Published 4 years ago

ngx-csv v0.3.2

Weekly downloads
5,113
License
MIT
Repository
github
Last release
4 years ago

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)

OptionDefaultDescription
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.
showLabelsfalseIf provided, would use this attribute to create a header row
showTitlefalse
useBomtrueIf true, adds a BOM character at the start of the CSV
noDownloadfalseIf true, disables automatic download and returns only formatted CSV

Options Example

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

  ngxCsv(data, filename, options);

Credits