A jQuery plugin to create a dynamic, multi-column layout.
Clone or download
Pull request Compare This branch is 126 commits behind germanysbestkeptsecret:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
css
example-amd
example-api
example-endless-scroll
example-filter
example-flexible
example-lightbox
example-load-images
example-placeholder
example-sort
example
libs
sample-images
.gitignore
CHANGELOG.md
Gruntfile.coffee
MIT-LICENSE.txt
README.md
jquery.wookmark.js
jquery.wookmark.min.js
wookmark.jquery.json

README.md

jQuery Wookmark

This is a jQuery plugin for laying out a dynamic grid of elements.

See the documentation page for examples.

The repository also includes two functional examples. All images used in the example are copyrighted by their respective owners and only included for showcasing plugin functionality.

Do you like this project? Buy me a beer

Installation

Prequisites

Required files

Copy jquery.wookmark.js to your javascript folder.

Usage

The plugin can be called with jQuery in different ways.

Standard call with default settings:

$('.myElements').wookmark();

Where myElement is the class of the items you want to lay out in a grid.

Options

$('.myElements').wookmark({
  align: 'center',
  autoResize: false,
  container: $('body'),
  ignoreInactiveItems: true,
  itemWidth: 0,
  fillEmptySpace: false,
  flexibleWidth: 0,
  offset: 2,
  onLayoutChanged: undefined,
  outerOffset: 0,
  resizeDelay: 50
});

See the documentation page for details on available options.

itemWidth and flexibleWidth

These values can be given as numbers which will be interpreted as pixels or you can use percentage strings like '20%'. When flexibleWidth is set an itemWidth != 0 is used as minimum item width. As example using a flexibleWidth of 40% will result in two columns with 10% space to the sides of the container.

Refresh trigger

Elements which are hidden have cannot be laid out until they are visible. If you use wookmark on a hidden tab layout will not be immediately performed. When the tab is made visible you can manually refresh wookmark using a trigger on your container.

$('#myContent').trigger('refreshWookmark');

fillEmptySpace

This creates placeholders at the bottom of each column to create an even layout. See example-placeholder on how to use it. These placeholders use the css class wookmark-placeholder. You can overwrite it in your own css to fit your needs.

ignoreInactiveItems

When set to false inactive items will still be shown when filtered. This can be used to fade out filtered items. See the example-filter/fade.html example.

Included examples

example

Is the preferred setup. In this scenario the width and height of all images is set in the HTML img attributes. The grid layout can be performed as soon as the document is rendered, BEFORE images are loaded.

example-load-images

In this example, the width and height of the images is not known. Via Paul Irish's imagesLoaded plugin (slightly modified by desandro). The grid layout is performed after all images are loaded and their dimensions can be retrieved. This approach is much slower. The imagesLoaded plugin can also be found on github right here: https://gist.github.com/797120

example-amd

This example shows how to load and initialize the plugin when using require.js or a different amd loading method.

example-api

This example shows how to load the tile data from a remote api and layout it.

example-endless-scroll

This example shows how to add new tiles at runtime and refresh the layout.

example-filter

This example shows to use the filter feature of the plugin to show just the tiles the user wants.

example-flexible

This example shows how to use the flexibleWidth option. This option allows your tiles to grow a certain amount, as long as there is room. When using percentage values for the width options you can create a fixed column count layout.

example-lightbox

This example shows you how to include a lightbox.

example-placeholder

This example shows you how to enable placeholders at the bottom of the tile layout to create an even footer.

example-sort

This example shows how the sort feature works. This option allows you to specify a sorting function which will rearrange your tiles. For example you can use it to sort your tiles containing products by price, popularity or name.

FAQ

The tiles overlap after loading.

You should use the 'imagesloaded' plugin. Most the examples in this package include the code how to use it.

The tiles overlap after their height is changed.

Use the 'finished'-callback of your animation/effect to trigger 'refreshWookmark' on the container element supplied to the plugin.

The placeholders at the end of each column have wrong heights or positions.

Set 'position: relative' on your container element and check if there are other elements in the container before your tiles.

My question isn't answered here.

Send us some feedback or create an issue on github.

Feedback

Please send code specific questions and feedback to Sebastian or contact him on twitter.

If you have other questions and feedback which is for example related to Wookmark send a mail to Christoph or contact him on twitter.

Contributing

Contribute!