npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-full-gallery

v1.2.8

Published

A react image gallery with upload, edit, remove images.

Downloads

146

Readme

React Full Gallery

A react image gallery with upload, edit, remove images.

Installation

In your project directory, run:

npm install react-full-gallery

Demo

Here are the demos of some features like inserting image from unsplash and editing images.

Insert image from local

Insert image from local Demo

Insert image from Unsplash

Insert image from Unsplash Demo

Edit Image

Edit image Demo

How to use

import ImageGallery from 'react-full-gallery';
<ImageGallery 
    images={images}
    targetId='image-gallery'
    formTargetId='image-gallery-upload-form' 
    note={'Images only, up to 2 MB'}
    remoteSources={['Dropbox', 'Facebook', 'GoogleDrive','Instagram', 'OneDrive', 'Unsplash', 'Url']}
    loading={loading}
    allowMultipleEdit={allowMultipleEdit}
    allowMultipleDelete={allowMultipleDelete}
    handleUploadImages={handleUploadImages} 
    handleUpdateImages={handleUpdateImages}
    handleRemoveImages={handleRemoveImages} 
    companionUrl='http://localhost:55728/companion'
/>

Types

type UppyFileType = UppyFile<Record<string, unknown>, Record<string, unknown>>;

Interfaces

interface FilesInterface {
    [key: string]: UppyFileType;
}
interface ImageInterface {
    // Id of the image.
    id: string;
    // Original URL of the image.
    originalUrl: string;
    // Preview URL of the image which is used for image gallery to show the images. If set to undefined, the originalUrl will be used.
    previewUrl?: string;
    // Name of the image.
    name: string;
    // How many times the image is used in your website/content/etc.
    numberOfUse?: number;
    // The filed is used to know if the image was edited by the user or not.
    modified?: boolean;
}
interface ImageGalleryInterface {
    // Companion handles the server-to-server communication between your server and file storage providers such as Google Drive, Dropbox, etc. Read more here: https://uppy.io/docs/companion/
    companionUrl: string;
    // List of the image providers.
    remoteSources?: ('Box' | 'Dropbox' | 'Facebook' | 'GoogleDrive' | 'Instagram' | 'OneDrive' | 'Unsplash' | 'Url' | 'Zoom')[];
    // Target id of the image gallery HTML element.
    targetId: string;
    // Target id of the image gallery form HTML element.
    formTargetId: string;
    // Target id of the image gallery dropzone HTML element.
    dropTargetId?: string;
    // Height of the image gallery.
    height?: number;
    // Some custom tips/notes for your users
    note: string;
    // Style of the image gallery.
    style?: React.CSSProperties;
    // An array of your images.
    images: ImageInterface[];
    // Max allowed size for each image.
    maxFileSize?: number;
    // Allowed types for images.
    allowedFileTypes?: string[];
    // Loading state.
    loading?: boolean;
    // Allow multiple edit.
    allowMultipleEdit?: boolean;
    // Allow multiple delete.
    allowMultipleDelete?: boolean;
    // Your custom logic before adding an image.
    onBeforeFileAdded?: (currentImage: UppyFileType, images: FilesInterface) => UppyFileType | undefined | boolean;
    // Your custom logic before uploading images.
    onBeforeUpload?: (images: FilesInterface) => FilesInterface | boolean;
    // Your upload handler.
    handleUploadImages: (newImages: ImageInterface[]) => Promise<void>;
    // Your update handler.
    handleUpdateImages: (modifiedImages: ImageInterface[]) => Promise<void>;
    // Your remove handler.
    handleRemoveImages: (removedImages: ImageInterface[], newImages: ImageInterface[]) => Promise<void>;
}