Socket
Socket
Sign inDemoInstall

react-file-previewer

Package Overview
Dependencies
343
Maintainers
1
Versions
36
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-file-previewer

A browser/device-agnostic file previewer for PDF and image file types built on top of React-PDF.


Version published
Weekly downloads
1.5K
decreased by-22.17%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

react-file-previewer

A browser/device-agnostic file previewer for PDF and image file types built on top of React-PDF.

Installation

npm i react-file-previewer

Usage

This component supports URLs and base64 encoded data.

Basic Usage

import ReactFilePreviewer from 'react-file-previewer';

export const App = () => (
    <div>
        <h1>My App</h1>
        <ReactFilePreviewer file={{
            url: "https://cors-anywhere.herokuapp.com/http://africau.edu/images/default/sample.pdf"}}
        />
    </div>
);

Base64 Usage

import ReactFilePreviewer from 'react-file-previewer';

export const App = () => (
    <div>
        <h1>My App</h1>
        <ReactFilePreviewer 
            file={{
                data: "<base64 string>",
                mimeType: 'application/pdf',
                name: 'sample.pdf' // for download
            }}
        />
    </div>
);

Using with HTML file input

import { useState } from 'react';
import ReactFilePreviewer from 'react-file-previewer';

const PDF1_URL =
  'https://cors-anywhere.herokuapp.com/http://africau.edu/images/default/sample.pdf';

export const App = () => {
    const [file, setFile] = useState({ url: PDF1_URL });
    
    const onFileChange = event => {
        const fileReader = new window.FileReader();
        const file = event.target.files[0];
        
        fileReader.onload = fileLoad => {
            const { result } = fileLoad.target;
            setFile({ url: result });
        };
        
        fileReader.readAsDataURL(file);
    };

    return (
        <div>
            <h1>My App</h1>
            <input type="file" onChange={onFileChange} />
            <ReactFilePreviewer 
                file={file}
            />
        </div>
    )
};

Props

Prop nameTypeDescription
fileobjectRefer to file object
onClickfunctionEvent handler for when viewer is clicked
hideControlsboolIf 'true', viewer won't display the zoom, page up/down, and fit-to-screen controls
heightstringHeight of the viewer passed to the css styles
widthstringWidth of the viewer passed to the css styles

File Object

Prop nameTypeDescription
urlstringThis can be used by itself with no other prop
datastringBase64 encoded string of file. If used, mimeType must also be provided
mimeTypestringType of the file
namestringUsed to specify the filename when download button is clicked

Keywords

FAQs

Last updated on 19 Apr 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc