v-download
v1.2.1
Published
Vue.js directive to download (and optionally transform) data
Downloads
265
Readme
v-download
Vue.js directive to download (and optionally transform) data
Install
For browser usage, import the component by adding a src tag in the header ():
<script src="https://unpkg.com/[email protected]/dist/main.js">
For Node usage, install the v-download package using npm
npm install --save v-download
Usage
First register the directive globally:
import DownloadData from 'v-download'
Vue.use(DownloadData)
Or locally:
import { downloadData } from 'v-download'
export default {
directives: {
downloadData
}
}
Then use it in template:
<template>
<button v-download-data="`some text`">Download!</button>
</template>
Data type
If type is provided it will be used as the mimetype:
<template>
<button v-download-data="`{'example':'some text'}`" v-download-data:type="'json'">Download!</button>
</template>
If an object or array (instead of a string) is provided and the type is 'csv', 'tsv' or 'json', the object/array will be converted (json will be convert using JSON.stringify, csv/tsv is assuming an array and will be iterated)
<template>
<button v-download-data="myObject" v-download-data:type="'json'">Download!</button>
</template>
File name
If filename is provided it will be used as the downloaded file name:
<template>
<button v-download-data="`{'example':'some text'}`" v-download-data:filename="'mydownload.json'">Download!</button>
</template>