baguetteBox.js

[![GitHub Release](https://img.shields.io/github/release/feimosi/baguetteBox.js.svg)](https://github.com/feimosi/baguetteBox.js/releases) [![MIT License](https://img.shields.io/npm/l/baguettebox.js.svg)](https://github.com/feimosi/baguetteBox.js/blob/dev/LICENSE) [![dependency Status](https://img.shields.io/badge/dependencies-none-blue.svg)](https://david-dm.org/feimosi/baguetteBox.js) [![devDependency Status](https://img.shields.io/david/dev/feimosi/baguetteBox.js.svg)](https://david-dm.org/feimosi/baguetteBox.js?type=dev) [![npm](https://img.shields.io/npm/dm/baguettebox.js.svg)](https://www.npmjs.com/package/baguettebox.js) [![Build Status](https://travis-ci.org/feimosi/baguetteBox.js.svg?branch=master)](https://travis-ci.org/feimosi/baguetteBox.js) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/feimosi) [![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20baguetteBox.js%20-%20simple%20and%20easy%20to%20use%20lightbox%20script%20written%20in%20pure%20JavaScript%0Ahttps%3A%2F%2Fgithub.com%2Ffeimosi%2FbaguetteBox.js) [![Twitter Follow](https://img.shields.io/twitter/follow/feimosi.svg?style=social&label=Follow%20the%20author)](https://twitter.com/feimosi) Simple and easy to use lightbox script written in pure JavaScript. [Demo page](https://feimosi.github.io/baguetteBox.js/) ![Demo Page screenshot](https://i.imgur.com/GMmnud0.jpg) ## Table of contents * [Features](#features) * [Installation](#installation) * [Importing](#importing) * [Usage](#usage) * [Customization](#customization) * [API](#api) * [Responsive images](#responsive-images) * [Compatibility](#compatibility) * [Contributing](#contributing) * [Donation](#donation) * [Credits](#credits) * [License](#license) ## Features * Written in pure JavaScript, no dependencies required * Multiple-gallery support allows custom options for each * Supports swipe gestures on touch-screen devices * Full-screen mode available * Modern and minimal look * Image captions support * Responsive images * CSS3 transitions * SVG buttons, no extra files to download * Around 3.2KB gzipped * With Accessibility in mind ## Installation You can use one of the following methods: ### npm ```sh npm install baguettebox.js --save ``` ### Yarn ```sh yarn add baguettebox.js ``` ### Bower ```sh bower install baguettebox.js --save ``` ### CDN 1. Use one of the following CDN providers: - https://cdnjs.com/libraries/baguettebox.js - https://jsdelivr.com/projects/baguettebox.js 3. Copy URLs of the latest version (both `.js` and `.css` files) 2. Paste the URLs in your HTML file: ```html ``` ### Manually 1. Download `baguetteBox.min.css` and `baguetteBox.min.js` files from the `dist` folder. 2. Include them somewhere in your document: ```html ``` ## Importing ### Traditional approach If you don't use JavaScript modules and include the file with a ` ``` ## Customization You can pass an object with custom options as the second parameter. ```js baguetteBox.run('.gallery', { // Custom options }); ``` The following options are available: | Option | Type | Default | Description | | --- | --- | --- | --- | | `captions` | `Boolean` \| `function(element)` | `true` | Display image captions. Passing a function will use a string returned by this callback. The only argument is `a` element containing the image. Invoked in the context of the current gallery array | | `buttons` | `Boolean` \| `'auto'` | `'auto'` | Display buttons. `'auto'` hides buttons on touch-enabled devices or when only one image is available | | `fullScreen` | `Boolean` | `false` | Enable full screen mode | | `noScrollbars` | `Boolean` | `false` | Hide scrollbars when gallery is displayed | | `bodyClass` | `String` | `'baguetteBox-open'` | Class name that will be appended to the `body` when lightbox is visible (works in IE 10+) | | `ignoreClass` | `String` | `null` | It will ignore images with given class put on `a` tag | | `titleTag` | `Boolean` | `false` | Use caption value also in the gallery `img.title` attribute | | `async` | `Boolean` | `false` | Load files asynchronously | | `preload` | `Number` | `2` | How many files should be preloaded | | `animation` | `'slideIn'` \| `'fadeIn'` \| `false` | `'slideIn'` | Animation type | | `afterShow` | `function` | `null` | Callback to be run after showing the overlay | | `afterHide` | `function` | `null` | Callback to be run after hiding the overlay | | `onChange` | `function(currentIndex, imagesCount)` | `null` | Callback to be run when image changes | | `overlayBackgroundColor` | `String` | `'rgba`
`(0,0,0,0.8)'` | Background color for the lightbox overlay | | `filter` | `RegExp` | `/.+\.(gif\|jpe?g\|png\|webp)/i` | Pattern to match image files. Applied to the `a.href` attribute | ## API ### `run(selector, userOptions)` Initialize baguetteBox.js - @param `selector` {string} - valid CSS selector used by `querySelectorAll` - @param `userOptions` {object} - custom options (see [#Customization](#customization)) - @return {array} - an array of gallery objects (reflects elements found by the selector) ### `show(index, gallery)` Show (if hidden) and move the gallery to a specific index - @param `index` {number} - the position of the image - @param `gallery` {array} - gallery which should be opened, if omitted assumes the currently opened one - @return {boolean} - true on success or false if the index is invalid Usage: ```js const gallery = baguetteBox.run('.gallery'); baguetteBox.show(index, gallery[0]); ``` ### `showNext` Switch to the next image - @return {boolean} - true on success or false if there are no more images to be loaded ### `showPrevious` Switch to the previous image - @return {boolean} - true on success or false if there are no more images to be loaded ### `hide` Hide the gallery ### `destroy` Remove the plugin with any event bindings ## Responsive images To use this feature, simply put `data-at-{width}` attributes on `a` tags with a value being the path to the desired image. `{width}` should be the maximum screen width the image can be displayed at. The script chooses the first image with `{width}` greater than or equal to the current screen width for best user experience. That last `data-at-X` image is also used in the case of a screen larger than X. Here's an example of what the HTML code can look like: ```html

``` If you have 1366x768 resolution baguetteBox.js will choose `"img/medium/2-1.jpg"`. If, however, it's 1440x900 it'll choose `"img/big/2-1.jpg"`. Keep the `href` attribute as a fallback (link to a bigger image e.g. of HD size) for older browsers. ## Compatibility Desktop: * IE 8+ * Chrome * Firefox 3.6+ * Opera 12+ * Safari 5+ Mobile: * Safari on iOS * Chrome on Android ## Contributing Feel free to report any issues! If you wish to contribute by fixing a bug or implementing a new feature, please first read the [CONTRIBUTING](./CONTRIBUTING.md) guide. ## Donation If you find this project useful and want to say thanks, you can buy me a cup of coffee :) [![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://paypal.me/feimosi) ## Credits Creation of `baguetteBox.js` was inspired by a great jQuery plugin [touchTouch](https://github.com/martinaglv/touchTouch). Huge thanks for providing a testing platform go to [![BrowserStack](https://i.imgur.com/rlVVZwG.png)](http://browserstack.com/) ## License Copyright (c) 2018 [feimosi](https://github.com/feimosi/) This content is released under the [MIT License](https://opensource.org/licenses/MIT).

	Stars	Issues	Version	Updated	Created
baguettebox.js	2,422	57	1.11.1	4 years ago	9 years ago
glightbox	1,932	36	3.3.0	2 months ago	6 years ago
lightbox2	6,090	72	2.11.4	a year ago	8 years ago
lightgallery	6,248	41	2.7.2	8 months ago	10 years ago
swipebox	1,959	189	1.4.6	8 years ago	8 years ago

baguettebox.js vs glightbox vs lightbox2 vs lightgallery vs swipebox

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past