@digital-cnzz/react-file-viewer
Extendable file viewer for web
Supported file formats:
- Images: png, jpeg, gif, bmp, including 360-degree images
- csv
- xslx
- docx
- Video: mp4, webm
- Audio: mp3
Usage
start
npm install @digital-cnzz/react-file-viewer
.
There is one main React component, FileViewer
, that takes the following props:
fileType
string: type of resource to be shown (one of the supported file formats, eg 'png'
). Passing in an unsupported file type will result in displaying an unsupported file type
message (or a custom component).
filePath
string: the url of the resource to be shown by the FileViewer.
onError
function [optional]: function that will be called when there is an error in the file viewer fetching or rendering the requested resource. This is a place where you can pass a callback for a logging utility.
errorComponent
react element [optional]: A component to render in case of error instead of the default error component that comes packaged with react-file-viewer.
unsupportedComponent
react element [optional]: A component to render in case the file format is not supported.
To use a custom error component, you might do the following:
// MyApp.js
import React, { Component } from 'react';
import logger from 'logging-library';
import FileViewer from 'react-file-viewer';
import { CustomErrorComponent } from 'custom-error';
const file = 'http://example.com/image.png';
const type = 'png';
class MyComponent extends Component {
render() {
return (
<FileViewer
fileType={type}
filePath={file}
errorComponent={CustomErrorComponent}
onError={this.onError}
/>
);
}
onError(e) {
logger.logError(e, 'error in file-viewer');
}
}