# angular-csv-files

> Helper library for create CSV file in Angular

Latest version **1.0.0** (published 2019-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install angular-csv-files
pnpm add angular-csv-files
yarn add angular-csv-files
bun add angular-csv-files
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-08-13 |
| First published | 2019-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 79.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 45 |
| Author | Abdullah Alhazmy |
| Maintainers | alhazmy13 |
| Keywords | angular, export-to-csv, export-to-excel, csv, excel, libreoffice, openoffice |

## Links

- npm: https://www.npmjs.com/package/angular-csv-files
- Repository: https://github.com/alhazmy13/angular-csv
- Homepage: https://github.com/alhazmy13/angular-csv#readme
- Issues: https://github.com/alhazmy13/angular-csv/issues
- npm.io page: https://npm.io/package/angular-csv-files

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2019-08-13

## README

![angularjs_logo](https://user-images.githubusercontent.com/4659608/37036392-9bf53686-2160-11e8-95fc-bbab638d7d60.png)

# Angular-csv | Export to CSV  in Angular


[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e2133aa828054d7c865563b50100eb8b)](https://www.codacy.com/app/me_101/angular-csv?utm_source=github.com&utm_medium=referral&utm_content=alhazmy13/angular-csv&utm_campaign=Badge_Grade)
[![Build Status](https://travis-ci.org/alhazmy13/angular-csv.svg?branch=master)](https://travis-ci.org/alhazmy13/angular-csv)
[![npm version](https://badge.fury.io/js/angular-csv.svg)](https://badge.fury.io/js/angular-csv)
[![GitHub license](https://img.shields.io/github/license/alhazmy13/angular-csv.svg)](https://github.com/alhazmy13/angular-csv)
![Angular](https://img.shields.io/badge/Angular-%3E%3D5.0-red.svg)
![npm](https://img.shields.io/npm/dm/angular-csv.svg)

> A helper library for creating CSV files in Angular.
> 

## Installation 

```javascript
npm install --save angular-csv
```

## Example 
```javascript

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' "
  },
  {
    name: 'Test 4',
    age: 10,
    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 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 |
| **nullToEmptyString** | false      | If true, all null values will be changed to empty strings |


## 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"],
    nullToEmptyString: true,
  };

  AngularCsv(data, filename, options);

```

## Credits



 * [sn123](https://github.com/sn123)
 * [arf1980](https://github.com/arf1980)
 * [rob-moore](https://github.com/rob-moore)

---
_Source: https://npm.io/package/angular-csv-files · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._