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

lightbox-kit

v2.3.20

Published

An image lightbox component for React.

Downloads

686

Readme

lightbox-kit

npm

Links

showcase

npm package

Lightbox Kit is a lightweight and customizable React component designed for creating visually appealing and interactive lightboxes. Perfect to showcase images, this component offers a sleek and user-friendly experience with configurable options.

Installation

To install Lightbox, use the following npm command:

npm install lightbox-kit

Usage

To use Lightbox in your project, import it as follows:

import Lightbox from 'lightbox-kit'
import 'lightbox-kit/styles';

function App() {
  return (
    <div>
      <Lightbox
        title="string"
        titleMaxLength={40}
        titleClassName="string"
        src="string"
        alt="string"
        isOverlayClickable={true}
        overlayClassName="string"
        opacity={60}
        closeIconClassname="string"
        theme="dark"
        allowDrag={false}
        imageClassName="string"
      >
        // ...
      </Lightbox>
    </div>
  )
}

Title

The title displayed in the lightbox. This can be truncated if it exceeds the specified length (see titleMaxLength).

Example:

<Lightbox title="string" titleMaxLength={40} titleClassName="string"
  // ...
</Lightbox>

Source

The URL or path of the image to be displayed in the lightbox. This is the main image shown when the lightbox is opened.

Example:

<Lightbox src="url/path" alt="description"> // ... </Lightbox>

Theme

Defines the visual theme of the lightbox. It adjusts the background color and text color to either light or dark theme. "light" uses lighter colors, and "dark" uses darker colors.

Exemple:

<Lightbox theme="dark">
  // ...
</Lightbox>

Image

The main image shown. Custom class name for the image element itself, allowing additional styling like borders, shadows, or other visual effects. allowDrag determines whether the image inside the lightbox can be dragged.

<Lightbox
  allowDrag={true} 
  imageClassName="string"
>
  // ...
</Lightbox>

Overlay

The overlay is the semi-transparent background layer that appears behind the lightbox content, dimming the rest of the screen. It allows users to focus on the lightbox while optionally providing a clickable area to close it.

Exemple:

<Lightbox
  isOverlayClickable={true}
  overlayClassName="string"
  opacity={60}
>
  // ...
</Lightbox>

Close

A custom class name for the close button's icon (X icon) that can be used to adjust its appearance, such as its size, color, or position.

Exemple:

<Lightbox closeIconClassName="string">
  // ...
</Lightbox>