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

@caldwell619/react-image-lightbox

v0.1.4

Published

A lightbox component for React

Downloads

9

Readme

React Image Lightbox

Forked from react-image-lightbox.

A flexible lightbox component for displaying images in a React project.

Demo

Why Fork?

The main reason is that the original seems to not be maintained anymore. The last commit was July 2021, and many of the issues are stale.

Some other issues:

  • Didn't have TypeScript types.
  • Class based, which isn't an issue itself, but more about the enhancement. It was all in one file, 1500 lines.
  • Dragging an image caused a console error about preventing the default on the event.
  • Demo was class based.
  • Using React Modal incorrectly. They recommend to keep it mounted, the og library has you conditionally render it.
    • This is slightly opinionated, but react-modal should be a peer dependency to avoid version conflicts if you also use it.

Features

  • Keyboard shortcuts (with rate limiting)
  • Image Zoom
  • Flexible rendering using src values assigned on the fly
  • Image preloading for smoother viewing
  • Mobile friendly, with pinch to zoom and swipe (Thanks, @webcarrot!)

Example

Pseudo code to get your started. See the demo for a full example.

import { Lightbox } from '@caldwell619/react-image-lightbox'
// This only needs to be imported once in your app
import '@caldwell619/react-image-lightbox/dist/style.css'

const images: string[] = [...]

const App = () => {
  // Define logic handlers and state

  return (
    <Lightbox
      isOpen={isOpen}
      mainSrc={images[0]}
      // ...rest props
    />
  )
}

Logic Helpers

For convenience, there is a set of logical helpers you can use for next and previous functionality.

import { Lightbox, useControlHelper } from '@caldwell619/react-image-lightbox'
const App = () => {
  const { activeIndex, isOpen, toggleOpen, moveNext, movePrev, nextImage, prevImage, mainImage } =
    useControlHelper(images)

  return (
    <Lightbox
      isOpen={isOpen}
      mainSrc={mainImage}
      nextSrc={nextImage}
      prevSrc={prevImage}
      onMovePrevRequest={movePrev}
      onMoveNextRequest={moveNext}
      onCloseRequest={toggleOpen}
    />
  )
}

Props

Full, yet WIP list of props

Contributing

WIP guide here

Contributor List

License

MIT