DownloadButton

DownloadButton is a simple component for letting the user download a javascript-generated file. It was extracted from Notablemind.

The styling is due to materializecss, and does not come with the DownloadButton component. You are free to style the component however you wish.

Demo

For more demos, see the demo page.

npm install --save downloadbutton

var DownloadButton = require('downloadbutton')

// use it somewhere!

If you're not using browserify, you'll need to use the precompiled version, as the source is written using jsx and es6 syntax.

var DownloadButton = require('downloadbutton/es5')

// use it

If you generate the file asynchronously, you need to set async to true, and use the next section.

Name	Type	Description
`fileData`	fileData	If passed in, genFile will be ignored, and this file will be served.
`genFile`	`fn () ->` fileData	Synchronously generate the file data. See below for a description of the `fileData` type
`downloadTitle`	`string` or react element, or `fn (fileData) -> string / react element`	The text shown on the button. If a function, it will be passed the `fileData` in the case that it has been passed in as props. Default: `"Download"`

You must pass in either fileData or genFile.

If fileData is passed in as a prop, the async prop is ignored, and the component will use the synchronous behavior.

Name	Type	Description
`async`	`bool`	Set to true if `genFile` is an async function. Default: false.
`generateTitle`	`string` or react element	The text shown initially. Default: `"Generate file"`
`loadingTitle`	`string` or react element	The text shown while the file is being generated. Default: `"Loading..."`
`downloadTitle`	`string` or react element, or `fn (fileData) -> string / react element`	The text shown on the button. If a function, it will be passed the generated `fileData`. Default: `"Download"`

{
  mime: str,
  filename: str,
  content: str
}

Example:

{
  mime: "application/json",
  filename: "generated.json",
  content: '{"hello": "world"}'
}