@react-pdf-viewer/get-file
TypeScript icon, indicating that this package has built-in type declarations

3.12.0 • Public • Published

download plugin

This plugin allows user to download the current file.

import { downloadPlugin } from '@react-pdf-viewer/download';

const downloadPluginInstance = downloadPlugin();

// The button to download the current file
const { Download } = downloadPluginInstance;

// Render
return (
    <>
    <Download />
    <Viewer
        plugins={[
            downloadPluginInstance,
        ]}
    >
    </>
);

Use a custom button

import { downloadPlugin } from '@react-pdf-viewer/download';

const downloadPluginInstance = downloadPlugin();

// The button to download the current file
const { Download } = downloadPluginInstance;

// Render
return (
    <>
    <Download>
    {
        (props) => (
            // Your custom button here
            <button onClick={props.onClick}>
                Download
            </button>
        )
    }
    </Download>
    <Viewer
        plugins={[
            downloadPluginInstance,
        ]}
    >
    </>
);

Plugin options

  • fileNameGenerator (Optional): Custom the name of download file.

It is a function accepts the current opened file and returns a string:

(file: OpenFile) => string;

By default, the name of download file is determined by the name properties of OpenFile. You can customize it as following:

import { OpenFile } from '@react-pdf-viewer/core';

const downloadPluginInstance = downloadPlugin({
    fileNameGenerator: (file: OpenFile) => {
        // `file.name` is the URL of opened file
        const fileName = file.name.substring(file.name.lastIndexOf('/') + 1);
        return `a-copy-of-${fileName}`;
    },
});

Package Sidebar

Install

npm i @react-pdf-viewer/get-file

Weekly Downloads

82,177

Version

3.12.0

License

https://react-pdf-viewer.dev/license

Unpacked Size

15.4 kB

Total Files

7

Last publish

Collaborators

  • phuoc-ng