Natural Gallery JS

A library that allows you to display images with with natural layouts, infinite scroll, lazy loading, lightbox and interactivity in a developer friendly by exposing an usefull api.

See the demo

Documentation

• Getting started
• Options
• Api and events
• Theming and customization

Install with NPM or Yarn

npm i @ecodev/natural-gallery-js

yarn add @ecodev/natural-gallery-js

Contributing

All contributions are welcome, but keep in mind that the gallery will stay simple : too generalist or too specific features that could be done from your controllers won't be added.

Found a bug ?

Create an issue where you report what you observe, what you expect to observe, and the context of usage, as well as your browser and it's version.

Want a new feature ?

Consider a pull request, but create an issue before to expose your idea. Maybe the feature you would like to add is already on the pipeline or is intentionally not included for good reasons.

Development

The most useful commands for development are:

• yarn dev to start a development server
• yarn build to build the lib and the docs locally (it will be published automatically by GitHub Actions deploy job)
• git tag -am 1.2.3 1.2.3 && git push to publish the lib to npm (via GitHub Actions release job)

Licence

Developed by Ecodev under MIT licence, the app is free of use, even for commercial usage. Even if it's not required, a credit would be much appreciated.

Credits

This gallery uses Photoswipe !