0.1.2 • Published 10 months ago
@resolve_ch/file-viewer v0.1.2
file-viewer
Supported file formats:
- bmp
- csv
- docx
- gif
- jpeg
- jpg
- png
- xlsx
Install
# via npm
npm install @resolve_ch/file-viewer
FileViewer example
import React from 'react';
import ReactDOM from 'react-dom';
import FileViewer from '@resolve_ch/file-viewer';
class App extends React.Component {
render() {
return (
<FileViewer
filePath="https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg"
</FileViewer>
);
}
}
ReactDOM.render(<App/>, document.body);
FileViewer props
{
// The url of the resource to be shown by the FileViewer.
filePath: 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).
// By default, the extension of the filePath is used to determine the fileType, but it can be overwritten using this prop.
fileType: string [optional]
// Can be used to extend the file-viwer or overwrite the existing drivers,
// format: '{ [key: string]: React.Component<props: { filePath: string, fileType: string }> }'
// eg: '{ mp4: VideoPlayerViewer }'
drivers: object [optional]
// Called when an error is thrown due to fetching or rendering problems
onError: function<error: Error, errorInfo: React.ErrorInfo> [optional]
// A component to render in case the file format is not supported.
UnsupportedComponent: ReactElement<props: { filePath: string, fileType: string }> [optional]
// A component to render in case an error is thrown
ErrorComponent: ReactElement<props: { error: Error }> [optional]
}
Local development
There is a demo app built into this library that can be used for development purposes.
npm run dev
Publish a new version
Log in to npm if not already done with npm login
, your account needs to be on the @resolve_ch
org.
npm run build
npm publish
0.0.20
10 months ago
0.0.21
10 months ago
0.0.15
10 months ago
0.0.16
10 months ago
0.0.17
10 months ago
0.0.18
10 months ago
0.0.19
10 months ago
0.0.10
10 months ago
0.0.11
10 months ago
0.0.12
10 months ago
0.0.13
10 months ago
0.0.14
10 months ago
0.1.0
10 months ago
0.1.2
10 months ago
0.1.1
10 months ago
0.0.9
10 months ago
0.0.8
1 year ago
0.0.7
1 year ago
0.0.6
3 years ago
0.0.5
3 years ago
0.0.4
3 years ago
0.0.3
3 years ago
0.0.2
3 years ago
0.0.1
3 years ago