Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikhilvashistha/ngxjsontocsvgenerator
A simple directive to be used for exporting Json to CSV.
https://github.com/nikhilvashistha/ngxjsontocsvgenerator
angular angular6 csv csv-export json jsontocsv ngx
Last synced: about 2 months ago
JSON representation
A simple directive to be used for exporting Json to CSV.
- Host: GitHub
- URL: https://github.com/nikhilvashistha/ngxjsontocsvgenerator
- Owner: NikhilVashistha
- License: mit
- Created: 2019-01-17T12:22:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-18T06:51:58.000Z (about 6 years ago)
- Last Synced: 2024-12-04T14:06:34.106Z (about 2 months ago)
- Topics: angular, angular6, csv, csv-export, json, jsontocsv, ngx
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@nikhil200816/ngx-json-to-csvgenerator
- Size: 112 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NgxJsonToCSVGenerator
* A simple `directive` to be used to download CSV from Json data.
* It is developed using `Angular >=6.0.0` and its newly introduced `ng g library` schematics.
* This library is part of NgxJsonToCSVGenerator project and it is generated with [Angular CLI](https://github.com/angular/angular-cli) version 6.0.8.
* Library location: `projects/ngx-json-to-csvgenerator` directory of this repository.
# ngx-json-to-csvgenerator | Export Json to CSV
[](https://badge.fury.io/js/%40nikhil200816%2Fngx-json-to-csvgenerator)  [](https://github.com/NikhilVashistha/NgxJsonToCSVGenerator)
> A directive to export CSV file from json in Angular 6 and above
>
## Installation
```javascript
npm install --save @nikhil200816/ngx-json-to-csvgenerator
```
## Examples/Demo
* A simple Example can be found under `src/app` directory of this repository.
> Add module in **app.module.ts**
```javascript
import { NgxJsonToCSVGeneratorModule } from '@nikhil200816/ngx-json-to-csvgenerator';
```
> Add in **imports** section
```javascript
imports: [
BrowserModule,
NgxJsonToCSVGeneratorModule
],
```
> Use in **component**
```javascript
const dataList = [
{
id: 1,
name: 'github',
price: '200$',
publisher: {
name: 'hieutran',
company: 'Dtag-VN'
},
nested:[
{
name: 'name1',
company: 'company1'
},
{
name: 'name2',
company: 'company2'
}]
},
{
id: 2,
name: 'twitter',
price: '500$',
publisher: {
name: 'twitter tran',
company: 'Canada'
},
nested:[]
},
{
id: 3,
name: 'google',
price: '300$',
publisher: {
name: 'tran',
company: 'Vietname'
},
nested:[
{
name: 'name3',
company: 'company3'
},
{
name: 'name4',
company: 'company4'
}]
}
];
```
```html
Export Button
Export Button
```
## Options
| Option | Description |
| :-------------| -----|
| **data** | Set the data array |
| **report-fields** | Name of the coloumn and keys to be exported |
| **nested-data-property** | If provided, will use nested value to export |
| **nested-report-fields** | Name of the coloumn and keys to be exported |
| **filename** | Set to change the file name |
## Running the example in local environment
* `npm install`
* Run `ng serve` for a dev server and running the demo app. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Build the NgxJsonToCSVGenerator module
Run `ng build NgxJsonToCSVGenerator` to build the library. The build artifacts will be stored in the `dist/ngx-json-to-csvgenerator` directory. Use the `--prod` flag for a production build.