Button to reset the instance
Main container for the instance
Display panel for the images
Hidden input
Visible input
The id you set for the instance
Generated using TypeDoc
Generated using TypeDoc
🖼 Simple file-upload utility that shows a preview of the uploaded image. Written in TypeScript. No dependencies. Works well with or without a framework.
yarn add file-upload-with-preview
Or, you can include it through the browser.
<link
rel="stylesheet"
type="text/css"
href="https://unpkg.com/file-upload-with-preview/dist/style.css"
/>
<script src="https://unpkg.com/file-upload-with-preview/dist/index.js"></script>
This is a simple frontend utility meant to help the file-upload process on your website.
It is written in pure JavaScript using TypeScript and has no dependencies. You can check out the live demo here.
For the most part, browsers do a good job of handling image-uploads. That being said - I find the ability to show our users a preview of their upload can go a long way in increasing the confidence in their upload.
file-upload-with-preview aims to address the issue of showing a preview of a user's uploaded image in a simple to use package.
multiple gridcachedFileArray (always will be an array) property of your FileUploadWithPreview object.FileUploadWithPreview object with its own uniqueId - this way you can have multiple file-uploads on the same page. You also can just use a single input designated with a multiple property to allow multiple files on the same input.This library looks for a specific HTML element to display the file-upload. Simply add the below div to your HTML. Make sure to populate your unique id in the data-upload-id attribute.
<div class="custom-file-container" data-upload-id="my-unique-id"></div>
Then, initialize your file-upload in the JavaScript like below:
import { FileUploadWithPreview } from 'file-upload-with-preview';
import 'file-upload-with-preview/dist/style.css';
const upload = new FileUploadWithPreview('my-unique-id');
Usage with Next.js / Tailwind :
'use client';
import { useEffect } from 'react';
import { FileUploadWithPreview } from 'file-upload-with-preview';
import 'file-upload-with-preview/dist/style.css';
export default function Uploader() {
useEffect(() => {
const upload = new FileUploadWithPreview('my-unique-id');
}, []);
return <div className="custom-file-container" data-upload-id="my-unique-id"></div>;
}
If you're importing directly in the browser, use the following instead:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<link
rel="stylesheet"
type="text/css"
href="https://unpkg.com/file-upload-with-preview/dist/style.css"
/>
</head>
<body>
<div class="custom-file-container" data-upload-id="my-unique-id"></div>
<script src="https://unpkg.com/file-upload-with-preview/dist/index.js"></script>
</body>
</html>
Then initialize like this:
const upload = new FileUploadWithPreview.FileUploadWithPreview('my-unique-id');
Then when you're ready to use the user's file for an API call or whatever, just access the user's uploaded file/files in the cachedFileArray property of your initialized object like this:
upload.cachedFileArray;
You can optionally trigger the image browser and clear selected images programmatically. There are additional methods on the class if you'd like to take a look at the source code.
upload.emulateInputSelection(); // to open image browser
upload.resetPreviewPanel(); // clear all selected images
You may also want to capture the event when an image is selected.
import { Events, ImageAddedEvent } from 'file-upload-with-preview';
window.addEventListener(Events.IMAGE_ADDED, (e: Event) => {
const { detail } = e as unknown as ImageAddedEvent;
console.log('detail', detail);
});
The cachedFileArray property is always an array. So if you are only allowing the user to upload a single file, you can access that file at cachedFileArray[0] - otherwise just send the entire array to your backend to handle it normally.
Make sure to pass in multiple: true in your options if you want to allow the user to select multiple images.
View the full docs here.
See the full example in the ./example/index.ts folder. See the top of this README for some links to a few live CodeSandbox's.
If you are supporting a browser like IE11, one way to add a polyfill for fetch and promise is by adding the following in the bottom of your index.html:
<script src="https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/fetch/2.0.3/fetch.js"></script>
# Install dependencies
yarn
# Watch changes during local development
yarn dev
# Run tests
yarn test
# Build library
yarn build
Go ahead and fork the project! Submit an issue if needed. Have fun!
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional backgroundBackground image for image grid
DEFAULT_BACKGROUND_IMAGE
Optional basePlaceholder image
DEFAULT_BASE_IMAGE
Optional successAlternate file upload image
DEFAULT_SUCCESS_FILE_ALT_IMAGE
Optional successPDF upload image
DEFAULT_SUCCESS_PDF_IMAGE
Optional successVideo upload image
DEFAULT_SUCCESS_VIDEO_IMAGE
Generated using TypeDoc
Options to customize the library
Optional acceptType of files to accept in your input
'*'
Optional imagesConfigurable images for the library
Optional maxSet a maximum number of files you'd like the component to deal with. Must be > 0 if set. By default there is no limit.
0
Optional multipleSet to true if you want to allow the user to selected multiple images. Will use grid view in the image preview if set.
false
Optional presetProvide an array of image paths to be automatically uploaded and displayed on page load (can be images hosted on server or URLs)
[]
Optional showShow a delete button on images in the grid
true
Optional textConfigurable text for the library
Generated using TypeDoc
Optional browseBrowse button text
"Browse"
Optional choosePlaceholder text
"Choose file..."
Optional labelMain input label text
"Upload"
Optional selectedCount descriptor text. Defaults to ${ n } files selected.
"files selected"
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Currently selected files
Default
[]