An accessible, open-source image lightbox with no dependencies.
CSS: dist/css/parvus.min.css minified, or dist/css/parvus.css un-minified
JavaScript: dist/js/parvus.min.js minified, or dist/js/parvus.js un-minified
Images: dist/images/zoom-in.svg and dist/images/zoom-out.svg
Parvus is also available on npm.
npm install parvus --save
You can install Parvus by linking the .css and .js files to your HTML file. The HTML code may look like this:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Page title</title>
<!-- CSS -->
<link href="path/to/parvus.min.css" rel="stylesheet">
</head>
<body>
<!-- HTML content -->
<!-- JS -->
<script src="path/to/parvus.min.js"></script>
</body>
</html>
The standard way of using Parvus is a linked thumbnail image with the class name lightbox to a larger image:
<a href="path/to/image.jpg" class="lightbox">
<img src="path/to/thumbnail.jpg" alt="">
</a>
Initialize the script by running:
const prvs = new parvus()
You can pass an object with custom options as an argument.
const prvs = new parvus({
scrollClose: false
})
The following options are available:
| Property | Type | Default | Description |
|---|---|---|---|
| selector | string | ".lightbox" | All elements with this class triggers Parvus |
| lightboxLabel | string | "..." | ARIA label for screen readers |
| lightboxLoadingIndicatorLabel | string | "..." | ARIA label for screen readers |
| swipeClose | bool | true | Swipe up to close Parvus |
| scrollClose | bool | true | Scroll to close Parvus |
| threshold | number | 100 | Touch dragging threshold (in px) |
| transitionDuration | number | 300 | Specifies how many milliseconds (ms) the transition effects takes to complete |
| transitionTimingFunction | string | '...' | Specifies the speed curve of the transition effects |
| Function | Description |
|---|---|
open(element) | Open element (DOM element) |
close() | Close Parvus |
add(element) | Add element (DOM element) |
remove(element) | Remove element (DOM element) |
isOpen() | Check if Parvus is open |
destroy() | Destroy Parvus |
Bind events with the .on() and .off() methods.
const prvs = new parvus()
const listener = function listener () {
console.log('eventName happened')
}
// bind event listener
prvs.on(eventName, listener)
// unbind event listener
prvs.off(eventName, listener)
| eventName | Description |
|---|---|
open | Triggered after Parvus has been opened |
close | Triggered after Parvus has been closed |
destroy | Triggered after Parvus has been destroyed |
Parvus supports the following browser (all the latest versions):
FAQs
An open source, dependency free image lightbox with the goal of being accessible.
The npm package parvus receives a total of 474 weekly downloads. As such, parvus popularity was classified as not popular.
We found that parvus demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.