UNPKG

angular7-csv

Version:

Helper library for create CSV file in Angular 7

93 lines (70 loc) 2.95 kB
![angularjs_logo](https://user-images.githubusercontent.com/4659608/37036392-9bf53686-2160-11e8-95fc-bbab638d7d60.png) # Angular5-csv | Export to CSV in Angular5 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/e2133aa828054d7c865563b50100eb8b)](https://www.codacy.com/app/me_101/angular5-csv?utm_source=github.com&utm_medium=referral&utm_content=alhazmy13/angular5-csv&utm_campaign=Badge_Grade) [![Build Status](https://travis-ci.org/alhazmy13/angular5-csv.svg?branch=master)](https://travis-ci.org/alhazmy13/angular5-csv) [![npm version](https://badge.fury.io/js/angular5-csv.svg)](https://badge.fury.io/js/angular5-csv) [![GitHub license](https://img.shields.io/github/license/alhazmy13/angular5-csv.svg)](https://github.com/alhazmy13/angular5-csv) ![Angular](https://img.shields.io/badge/Angular-%3E%3D5.0-red.svg) ![npm](https://img.shields.io/npm/dm/angular5-csv.svg) > Helper library for create CSV file in Angular5 > ## Installation ```javascript npm install --save angular5-csv ``` ## Example ```javascript 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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString).| | **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 | ## Options Example ```javascript var options = { fieldSeparator: ',', quoteStrings: '"', decimalseparator: '.', showLabels: true, showTitle: true, title: 'Your title', useBom: true, noDownload: true, headers: ["First Name", "Last Name", "ID"] }; Angular5Csv(data, filename, options); ``` ## Credits * [sn123](https://github.com/sn123) * [arf1980](https://github.com/arf1980)