ftw.showroom 1.5.1

Javascript library to make gallery overlays

Introduction

Table of Contents

• Introduction

  • Installation

  • Compatibility

• JavaScript development

  • Building

  • Testing

  • Links

  • Copyright

• Client library

  • Getting Started

  • Usage

  • Build options

  • Source Maps

  • Tests

  • Initialization

  • Configuration

  • Events

  • Fetching

  • Rendering

  • References

  • API

• Changelog

  • 1.5.1 (2018-03-12)

  • 1.5.0 (2018-03-08)

  • 1.4.0 (2017-07-11)

  • 1.3.1 (2016-11-02)

  • 1.3.0 (2016-10-18)

  • 1.2.1 (2016-08-29)

  • 1.2.0 (2016-08-23)

  • 1.1.1 (2016-07-04)

  • 1.1.0 (2016-06-27)

  • 1.0.0 (2016-05-24)

This package provides a javascript library to make gallery overlays such as Lightbox. But the main difference is that you have full control over the rendering and fetching of gallery items.

The gallery is able to notify if the user has reached the first or last item. This can be useful when more items should be loaded as a batch.

The items of the gallery can be extended or reset.

The gallery always tracks the active item.

An API provides a way to control the gallery from outside.

Installation

Add the package as dependency to your setup.py:

setup(...
      install_requires=[
        'ftw.showroom',
      ])

or to your buildout configuration:

[instance]
eggs += ftw.showroom

and rerun buildout.

Install the Generic Setup profile.

Compatibility

Plone 4.3

JavaScript development

Building

Rebuilding the library (resources/javascript.js):

grunt build

Watching for changes and rebuild the bundle automatically:

grunt watch

or the default task

grunt watch

Testing

Running all test:

npm test

or

grunt test

Running a specific test:

grunt test --grep="Name of your test"

Links

• Github: https://github.com/4teamwork/ftw.showroom

• Issues: https://github.com/4teamwork/ftw.showroom/issues

• Pypi: http://pypi.python.org/pypi/ftw.showroom

• Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.showroom

Copyright

This package is copyright by 4teamwork.

ftw.showroom is licensed under GNU General Public License, version 2.

Client library

Getting Started

The client library depends on Grunt. Assuming you already have Node.js installed on your system, run the following command:

sudo npm install -g grunt

To install the dependencies, run the following command:

npm install

And with npm you get the following packages:

• Grunt - JavaScript task runner.

• Babel - ES6 Transpiler.

• Browserify - Dependency Bundler

• Karma - JavaScript test runner.

• Jasmine - JavaScript test suite.

• Chai - JavaScript Assertion Library.

Usage

Run the following command to re-build the library:

grunt build

Run the following command to watch for changes which trigger a rebuild:

grunt

Build options

See https://github.com/substack/browserify-handbook for more information about browserify.

Source Maps

Browserify comes with a built-in support to generate source maps. It is already enabled by default, but feel free to disable source maps. Refer to this article to enable source maps in Google Chrome, if you haven’t already done so.

Tests

Run all tests

grunt test

Run a specific test

grunt test --grep="Name of your test"

Initialization

Creates an empty showroom instance with default options

let showroom = Showroom();

The showroom constructor accepts a NodeList or a jQuery. The items can provide a target as an HTML data attribute (data-showroom-target) to define the endpoint where the item will fetch its content from. To make a title visible in the overlay provide a title as an HTML data attribute (data-showroom-title).

<ul>
  <li class="item"
      data-showroom-target="http://target.com/1"
      data-showroom-title="title-1">
    <a>Item 1</a>
  </li>
  <li class="item"
      data-showroom-target="http://target.com/2"
      data-showroom-title="title-2">
    <a>Item 2</a>
  </li>
</ul>

let items = document.querySelectorAll(".item");
let showroom = Showroom(items);

or

let items = $(".item");
let showroom = Showroom(items);

Configuration

The showrooms provide the following options.

Option	Default	Description
cssClass	“ftw-showroom”	Class attribute on the root element of the gallery
render	See rendering. section	Override the default render behavior
tail	Empty function	Called when the user reaches the last element of the gallery
head	Empty function	Is getting called when the user reaches the first element of the gallery
fetch	See fetching. section	Override the default fetch behavior
beforeRender	noop	Hook to augment the item for example
template	See template section	Override the default gallery template
target	body Element	Define a selector where the gallery will be attached
offset	0	Offset for the current item counter, useful for batches

Events

ftw.showroom fires the following events on document:

Event	Params	Description
showroom:item:shown	showroom	Invoked every time an item is shown, so if showroom opens, every time the selected showroom item changes.

To listen to an event use the following code:

$(document).on('showroom:item:shown', function (showroom) {
  // do something with the showroom/item
})

Fetching

The default fetching function uses the target provided by each item to make an AJAX call to retrieve its content.

function fetch(item) { return $.get(item.target); };

This function can be overridden, see Configuration.

let showroom = Showroom(items,
  {
    fetch: (item) => { return "<p>Some other content</p>"; }
  }
);

Rendering

The default rendering function returns an HTML string using the default Handlebars template padding the internal showroom data, the prefeteched content and the active item.

function render(content) {
  return $.when(content).pipe((content) => {
    return $(template({ showroom: data, content: content, item: register.current }));
  });
}

This function can be overridden, see Configuration.

let showroom = Showroom(items,
  {
    render: (content) => { return $(template()); }
  }
);

References

References are useful if you want to open a showroom item that is referenced by more than one element on the same page. You just have to add the showroom-reference class and the data-showroom-target-item attribute to make the connection. The data-showroom-target-item attribute contains an id which references a showroom item on the page. You have to set the data-showroom-id by manually on the showroom item to make the connection with the reference.

There is currently no interface to make the connection manually. But you have to call showroom.refresh() to refresh the references.

<!-- The showroom item -->

<a href="#"
  class="showroom-item"
  data-showroom-id="your-unique-id"
  data-showroom-target="http://www.example.com"
  data-showroom-title="Example">Example<a/>

<!-- The reference (a link in that case) -->

<a class="showroom-reference"
   data-showroom-target-item="your-unique-id"></a>

API

Showroom.open

Opens a specific item. If no item is specified the showroom tries to show the first in the store otherwise it does nothing.

showroom.open();

or

showroom.open(item);

---

Showroom.close

Closes the overlay by hiding the element.

showroom.close();

---

Showroom.next

Opens the next item in the item queue. When the pointer reaches the last item the showroom does nothing.

showroom.next();

---

Showroom.prev

Opens the previous item in the item queue. When the pointer reaches the first item the showroom does nothing.

showroom.prev();

---

Showroom.append

Extend the current item queue with new items. The items are appended at the end of the queue. The pointer remains unaffected. The append method accepts a NodeList or a jQuery

let newItems = document.querySelectorAll(".newItems");
showroom.append(newItems);

or

let newItems = $(".newItems");
showroom.append(newItems);

---

Showroom.prepend

Extend the current item queue with new items, similar to the append method, but the items are prepended at the beginning of the queue. The pointer remains unaffected. The prepend method accepts a NodeList or a jQuery

let newItems = document.querySelectorAll(".newItems");
showroom.prepend(newItems);

or

let newItems = $(".newItems");
showroom.prepend(newItems);

---

Showroom.reset

Reset the current item store with new items. The overlay will be closed and the pointer set to 0. To empty the item store reset with no arguments.

let newItems = document.querySelectorAll(".newItems");
showroom.reset(newItems);

or

let newItems = document.querySelectorAll(".newItems");
showroom.reset();

---

Showroom.destroy

After destroying the showroom is no longer able to open any items. The store will be reset and the marker class removed. The overlay will be closed as well. All items will loose their data-showroom-id.

showroom.destroy();

---

Showroom.setTotal

Updates the total value and rerenders the opened overlay. The method does only allow numeric values.

showroom.setTotal(34);

---

Showroom.setOffset

Updates the offset. Prevents negative offsets. The method does only allow numeric values.

showroom.setOffset(42);

---

Showroom.refresh

Refreshes the showroom references.

showroom.refresh();

Changelog

1.5.1 (2018-03-12)

• 1.5.0 Did not work properly, since the dist command was not executed. [mathias.leimgruber]

1.5.0 (2018-03-08)

• Introduce “showroom:item:shown” event

1.4.0 (2017-07-11)

• Introduce before render hook. [Kevin Bieri]

1.3.1 (2016-11-02)

• Introduce uninstall profile [Kevin Bieri]

• Introduce upgrade steps [Kevin Bieri]

• Cleanup version pinnings [Kevin Bieri]

1.3.0 (2016-10-18)

• Refactor event binding using event delegation. Since these changes all the showroom items must have showroom-item class Therefore manually refreshing events is no longer necessary [Kevin Bieri]

1.2.1 (2016-08-29)

• Prevent register#set from calling tail twice [Kevin Bieri]

1.2.0 (2016-08-23)

• Make template configurable [Kevin Bieri]

• Introduce showroom references [Kevin Bieri]

• Provide offset option for showroom. The offset is added to the current number and allows to display correct item number for batched items. [deiferni]

1.1.1 (2016-07-04)

• Fix unordered list styles. [Kevin Bieri]

1.1.0 (2016-06-27)

• Provide option to prepend items to the showroom queue. [phgross]

1.0.0 (2016-05-24)

• Nothing changed yet