react-files-preview
v2.4.6
Published
A file view component for React apps with images preview, image editing, slider, download option and more.
Downloads
1,801
Maintainers
Readme
react-files-preview
A file view component for react.
Installation
npm
npm i react-files-preview
yarn
yarn add react-files-preview
Stackblitz - Check It Live
Basic Usage
import { ReactFilesPreview } from 'react-files-preview'
import 'react-files-preview/dist/style.css' /* import css file*/
function App() {
return (
<>
<ReactFilesPreview />
</>
)
}
export default App
Usage with Tailwind CSS
If your project uses Tailwind CSS, you don’t need to import the CSS file directly. Instead, add the following path to the content array in your tailwind.config.js file:
module.exports = {
content: [
'./src/**/*.{js,jsx,ts,tsx}',
'./node_modules/react-files-preview/dist/*.js', // Add this line
],
theme: {
extend: {},
},
plugins: [],
}
Props
| Name | Type | Default | Description |
| ------------ | --------- | ------------ | --------- |
| files
| File[] | [] | Pass array of file objects for default files |
| url
| string | null | Set image by passing image URL |
| downloadFile
| boolean | true | Enables file download |
| removeFile
| boolean | true | Show file remove icon on file hover |
| showFileSize
| boolean | true | Show file size under files |
| showSliderCount
| boolean | true | Show slides count under file slider |
| disabled
| boolean | false | If true, prevents user to add files by disabling the component |
| multiple
| boolean | true | Accepts one or more files |
| accept
| string | | Comma-separated lists of file types. See MIME Types |
| maxFileSize
| number | | Maximum allowed file size in bytes e.g. 1024 x 1024 x 5 == 5MB |
| maxFiles
| number | | Maximum files allowed to be added |
| width
| string | basis-11/12 | Tailwind CSS flex-basis class https://tailwindcss.com/docs/flex-basis |
| height
| string | | Tailwind CSS height class https://tailwindcss.com/docs/height |
| fileWidth
| string | w-44 | Tailwind CSS width class https://tailwindcss.com/docs/width |
| fileHeight
| string | h-32 | Tailwind CSS height class https://tailwindcss.com/docs/height |
| getFile
| func | | Returns all current files |
| onChange
| func | | Returns selected file(s) |
| onRemove
| func | | Returns the removed file |
| onError
| func | | Returns error message as string |
| onClick
| func | | Returns file on click |