vue-json-to-csv

vue-json-to-csv

A Vue.js 2 component to transform and download a json in csv format

Installation

npm install --save vue-json-to-csv or use dist/vue-json-to-csv.min.js

Usage

For vue-cli user:

import VueJsonToCsv from 'vue-json-to-csv'

For standalone usage:

<script src="vue.min.js"></script>
<!-- must place this line after vue.js -->
<script src="dist/vue-json-to-csv.min.js"></script>
<script type="text/javascript">
  Vue.use(VueJsonToCsv);
</script>

Sample 1

Simple usage: will generate a default button. The csv will include all the labels (name, surname) and the data

<vue-json-to-csv :json-data="[
    { name: 'Joe', surname: 'Roe' },
    { name: 'John', surname: 'Doe' }
  ]">
</vue-json-to-csv>

Result csv

csv.csv

name	surname
Joe	Roe
John	Doe

Sample 2

Selected labels with custom csv title: will generate a custom button as defined at the slot. The csv will include only the "name" label with the "First name" title and the relevant data.

<vue-json-to-csv :json-data="[
    { name: 'Joe', surname: 'Roe' },
    { name: 'John', surname: 'Doe' }
  ]"
  :labels="{ name: { title: 'First name' } }"
  :csv-title="My_CSV"
  >
</vue-json-to-csv>

Result csv

My_CSV.csv

First name
Joe
John

Sample 3

Handle success/error: use of custom methods on success or error.

<vue-json-to-csv :json-data="[
    { name: 'Joe', surname: 'Roe' },
    { name: 'Joe', surname: 'Doe' }
  ]"
  @success="val => handleSuccess(val)"
  @error="val => handleError(val)">
</vue-json-to-csv>

Configuration

Prop	Details
json-data	Array of the objects which contain the data to display (required). Each key will be a different column at the csv. All the objects should contain the same keys. If empty array an error will be returned. Example: [ { name: 'Joe', surname: 'Roe' }, { name: 'Joe', surname: 'Doe' }]
show-labels	Boolean. If false the first row of the csv will not contain the labels names.
labels	An object of the keys of the labels will be displayed. Use to filter the keys to display and modify their label title. For each key we provide the title of the key to displayed. If not defined all the keys will be parsed. Example: { name: { title: 'First name' } }
csv-title	String. The title of the generated csv. Default: 'csv'
@update:error	Will be triggered in case of an empty json array, if the labels object has not children or any parsing issue
@update:success	Will be triggered in case of a successful csv creation