Skip to content

projectblacklight/blacklight-gallery

Repository files navigation

Blacklight::Gallery

Gem Version CI

Gallery views for Blacklight search results

Installation

Add this line to your Blacklight application's Gemfile:

gem 'blacklight-gallery'

And then execute:

$ bundle

Or install it yourself as:

$ gem install blacklight-gallery

Usage

Run the gallery generator for Sprockets:

$ rails g blacklight_gallery:install

Or for node based bundlers add blacklight-gallery masonry-layout@v4 as a dependencies and add this to your entrypoint:

import 'blacklight-gallery/vendor/assets/javascripts/imagesloaded.pkgd.js'
import 'blacklight-gallery/app/assets/javascripts/blacklight_gallery/slideshow'
import 'blacklight-gallery/app/assets/javascripts/blacklight_gallery/masonry'

Available Views

If you would like to add or remove any particular view either add or remove the following configurations from your Blacklight controller.

Gallery

config.view.gallery.partials = [:index_header, :index]

Masonry

config.view.masonry.partials = [:index]

Slideshow

config.view.slideshow.partials = [:index]

Screenshot

Screenshot

Contributing

  1. Fork it ( http://github.com//blacklight-gallery/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Releasing

  1. Edit lib/version.rb and package.json to set the new version
  2. Commit the changes e.g. git commit -am "Bump version to X.X.X"
  3. Push release to rubygems bundle exec rake release
  4. Push release to NPM npm publish
  5. Create a release on github with the tag that was just created: https://github.com/projectblacklight/blacklight-gallery/releases/new