https://github.com/Ecodev/natural-gallery-js
A lazy load, infinite scroll and natural layout list gallery
https://github.com/Ecodev/natural-gallery-js
gallery hacktoberfest javascript lightbox natural responsive typescript
Last synced: 7 months ago
JSON representation
A lazy load, infinite scroll and natural layout list gallery
- Host: GitHub
- URL: https://github.com/Ecodev/natural-gallery-js
- Owner: Ecodev
- License: mit
- Created: 2016-02-05T10:25:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T21:10:40.000Z (about 1 year ago)
- Last Synced: 2024-12-22T17:49:41.920Z (10 months ago)
- Topics: gallery, hacktoberfest, javascript, lightbox, natural, responsive, typescript
- Language: TypeScript
- Homepage: https://ecodev.github.io/natural-gallery-js/
- Size: 14.9 MB
- Stars: 133
- Watchers: 11
- Forks: 26
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Natural Gallery JS
[](https://github.com/Ecodev/natural-gallery-js/actions)
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](https://ecodev.github.io/natural-gallery-js/)
[](https://ecodev.github.io/natural-gallery-js/)
# Documentation
- [Getting started](https://ecodev.github.io/natural-gallery-js/docs-getting-started.html)
- [Options](https://ecodev.github.io/natural-gallery-js/docs-options.html)
- [Api and events](https://ecodev.github.io/natural-gallery-js/docs-api.html)
- [Theming and customization](https://ecodev.github.io/natural-gallery-js/docs-theming.html)
# Install with NPM or Yarn
```sh
npm i @ecodev/natural-gallery-js
```
```sh
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.
# Testing
```
yarn test
```
# Licence
Developed by [ecodev](https://ecodev.ch) 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](http://photoswipe.com/) !