Skip to content
 
 

Repository files navigation

angular_logo

angular-csv | Export to CSV in Angular

npm version GitHub license Angular npm

A helper library for creating CSV files in Angular.

Installation

npm install --save angular-csv

Example

import { AngularCsv } from 'angular-csv/dist/Angular-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' "
  }
];

new AngularCsv(data, 'My Report');

API | AngularCsv(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 default
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
title 'My Report' Title of the CSV file, shown when showTitle is true
useBom true If true, adds a BOM character at the start of the CSV
useHeader false If true, only fields listed in headers will be exported
useObjHeader false If true, uses objHeader keys as export order and values as labels
noDownload false If true, disables automatic download and returns only formatted CSV
headers [] Array of column header labels
objHeader {} Object map of data keys to custom labels
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"],
  useHeader: false,
  nullToEmptyString: true,
};

new AngularCsv(data, filename, options);

Credits

About

Helper library for create CSV file in Angular 5

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages