masonry-rails 0.1.0

data/spec/_posts/docs/2011-05-01-intro.mdown

@@ -0,0 +1,149 @@
+---
+
+title: Introduction
+category: docs
+layout: default
+toc:
+  - { title: Getting started, anchor: getting_started }
+  - { title: Code repository, anchor: code_repository }
+  - { title: Acknowledgments, anchor: acknowledgments }
+  - { title: Changelog, anchor: changelog }
+  - { title: License, anchor: license }
+
+---
+
+Masonry is a dynamic grid layout plugin for jQuery. Think of it as the flip-side of CSS floats. Whereas floating arranges elements horizontally then vertically, Masonry arranges elements vertically, positioning each element in the next open spot in the grid. The result minimizes vertical gaps between elements of varying height, just like a mason fitting stones in a wall.
+
+## Getting started
+
+
+
+### Markup
+
+Masonry works on a container element with a group of similar child items.
+
+{% highlight html %}
+
+<div id="container">
+  <div class="item">...</div>
+  <div class="item">...</div>
+  <div class="item">...</div>
+  ...
+</div>
+
+{% endhighlight %}
+
+Add jQuery and the Masonry script. Masonry requires jQuery v1.4.0 and greater.
+
+{% highlight html %}
+
+<script src="//ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
+<script src="/path/to/jquery.masonry.min.js"></script>
+
+{% endhighlight %}
+
+### CSS
+
+All sizing of items is handled by your CSS. Items should be floated.
+
+{% highlight css %}
+
+.item {
+  width: 220px;
+  margin: 10px;
+  float: left;
+}
+
+{% endhighlight %}
+
+### Script
+
+It is recommended you specify an `itemSelector` and `columnWidth`. There are a number of other [options](options.html) you can specify.
+
+{% highlight javascript %}
+
+$(function(){
+  $('#container').masonry({
+    // options
+    itemSelector : '.item',
+    columnWidth : 240
+  });
+});
+
+{% endhighlight %}
+
+That's it!
+
+[**See Demo: Basic multi-column**](../demos/basic-multi-column.html)
+
+
+### imagesLoaded plugin
+
+If your content contains any images, you'll want to ensure that Masonry is triggered after all the images your content has loaded. The included [imagesLoaded plugin](https://github.com/desandro/imagesloaded) makes this easy.
+
+{% highlight javascript %}
+
+var $container = $('#container');
+$container.imagesLoaded(function(){
+  $container.masonry({
+    itemSelector : '.item',
+    columnWidth : 240
+  });
+});
+
+{% endhighlight %}
+
+[See Demo: Images](../demos/images.html)
+
+## Code repository
+
+This project lives on GitHub at [github.com/desandro/masonry](http://github.com/desandro/masonry). There you can grab the latest code and follow development.
+
+## Acknowledgments
+
++ Louis-Rémi Babé and Paul Irish for the [jQuery SmartResize plugin](http://github.com/louisremi/jquery-smartresize). De-bounced window resize event handler. Used within Masonry.
++ Paul Irish and Luke Shumard for [Infinite Scroll](http://www.infinite-scroll.com). Pretty much Masony's BFF &lt;3.
++ The Modernizr team for [Modernizr](http://www.modernizr.com/). Used in most of these demos.
++ Paul Irish et. al. for [imagesLoaded plugin](https://gist.github.com/268257). Used within Masonry.
++ [Ralph Holzmann](http://twitter.com/ralphholzmann) for re-writing the [jQuery Plugins/Authoring tutorial](http://docs.jquery.com/Plugins/Authoring) and opened my eyes to [Plugin Methods](http://docs.jquery.com/Plugins/Authoring#Plugin_Methods) pattern.
++ [Eric Hynds](http://www.erichynds.com/) for his article [Using $.widget.bridge Outside of the Widget Factory](http://www.erichynds.com/jquery/using-jquery-ui-widget-factory-bridge/) which provided the architecture for Masonry.
+
+## Changelog
+
+<dl>
+  <dt>v2.1: 9 Dec 2011</dt>
+    <dd>Pass in a function for <code>columnWidth</code> for easier fluid layouts</dd>
+  <dt>v2.0: May 2011</dt>
+    <dd>Complete re-write. Uses <code>$.Mason</code> constructor, like jQuery UI widget</dd>
+    <dd>Add options <code>gutterWidth</code>, <code>isFitWidth</code> for centering layout, <code>isRTL</code> for right-to-left layout</dd>
+    <dd>Add all new methods like <code>appended</code>, and <code>reload</code></dd>
+    <dd>Remove filtering demos</dd>
+  <dt>v1.3: 3 Sep 2010</dt>
+    <dd>Revamped <code>appendedContent</code> to work with container elements.  Plays nice with latest Infinite Scroll.</dd>
+    <dd>Revised layout for documentation to allow for more pages.</dd>
+  <dt>v1.2: 12 Jun 2010</dt>
+    <dd>Support for filtering added</dd>
+  <dt>v1.1: 29 Apr 2010</dt>
+    <dd>Add animation</dd>
+  <dt>v1.0: 7 Dec 2009</dt>
+    <dd>Multi-column width support</dd>
+  <dd>Appending elements and Infinite Scroll support</dd>
+    <dd>Less obstrusive layout. No inserting additional markup.</dd>
+    <dd>Automatically binds event to window resizing</dd>
+  <dt>v0.4: 14 Jun 2009</dt>
+    <dd>Better fluid rearrangement support</dd>
+  <dt>v0.1: Feb 2009</dt>
+    <dd>Original release</dd>
+</dl>
+
+## License
+
+jQuery Masonry is licensed under the MIT license. It may be used for personal and commercial applications.
+
+<div class="license-copy">
+  <h3>The MIT License</h3>
+  <p>Copyright &copy; 2012 David DeSandro</p>
+  <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
+  <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
+  <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
+</div>

data/spec/_posts/docs/2011-05-02-options.mdown

@@ -0,0 +1,157 @@
+---
+
+title: Options
+category: docs
+layout: default
+body_class: options
+toc :
+  - { title: animationOptions, anchor: animationoptions }
+  - { title: columnWidth, anchor: columnwidth }
+  - { title: containerStyle, anchor: containerstyle }
+  - { title: gutterWidth, anchor: gutterwidth }
+  - { title: isAnimated, anchor: isanimated }
+  - { title: isFitWidth, anchor: isfitwidth }
+  - { title: isResizable, anchor: isresizable }
+  - { title: isRTL, anchor: isrtl }
+  - { title: itemSelector, anchor: itemselector }
+
+---
+
+Options are set with an object as second argument to the `.masonry()` method. All options are optional, and do not need to be set, but [`itemSelector`](#itemselector) and [`columnWidth`](#columnwidth) are recommended.
+
+{% highlight javascript %}
+
+$('#container').masonry({
+  itemSelector: '.box',
+  columnWidth: 240,
+  animationOptions: {
+    duration: 400
+  }
+});
+
+{% endhighlight %}
+
+<dl class="header clearfix">
+  <dt><code>option</code></dt>
+  <dd class="option-type">Type</dd>
+  <dd class="default">Default</dd>
+</dl>
+
+## animationOptions
+
+<dl class="clearfix">
+  <dt><code>animationOptions</code></dt>
+  <dd class="option-type">Object</dd>
+  <dd class="default"><code>{ queue: <span class="kc">false</span>, duration: <span class="mi">500</span> }</code></dd>
+</dl>
+
+Options used for jQuery animation. See the [jQuery API for animate options](http://api.jquery.com/animate/#animate-properties-options) for details. More details in [Animating](animating.html).
+
+## columnWidth
+
+<dl class="clearfix">
+  <dt><code>columnWidth</code></dt>
+  <dd class="option-type">Integer</dd>
+</dl>
+
+Width in pixels of 1 column of your grid. If no columnWidth is specified, Masonry uses the width of the first item element.
+
+**Recommended** if your layout has item elements that have multiple-column widths.
+
+To set a dynamic column width, you can pass in a function that returns the value column width. The function provides an argument for the width of the container. Use this technique for fluid or responsive layouts.
+
+{% highlight javascript %}
+
+$('#container').masonry({
+  // set columnWidth a fraction of the container width
+  columnWidth: function( containerWidth ) {
+    return containerWidth / 5;
+  }
+});
+
+{% endhighlight %}
+
+[See Demo: Fluid](../demos/fluid.html).
+
+## containerStyle
+
+<dl class="clearfix">
+  <dt><code>containerStyle</code></dt>
+  <dd class="option-type">Object</dd>
+  <dd class="default"><code>{ position: <span class="s1">'relative'</span> }</code></dd>
+</dl>
+
+CSS properties applied to the container. Masonry uses relative/absolute positioning to position item elements.
+
+## gutterWidth
+
+<dl class="clearfix">
+  <dt><code>gutterWidth</code></dt>
+  <dd class="option-type">Integer</dd>
+  <dd class="default"><code><span class="mi">0</span></code></dd>
+</dl>
+
+Adds additional spacing between columns.
+
+[See Demo: Gutters](../demos/gutters.html).
+
+## isAnimated
+
+<dl class="clearfix">
+  <dt><code>isAnimated</code></dt>
+  <dd class="option-type">Boolean</dd>
+  <dd class="default"><code><span class="kc">false</span></code></dd>
+</dl>
+
+Enables jQuery animation on layout changes. [See Docs: Animating](animating.html). More details in [Animating](animating.html).
+
+## isFitWidth
+
+<dl class="clearfix">
+  <dt><code>isFitWidth</code></dt>
+  <dd class="option-type">Boolean</dd>
+  <dd class="default"><code><span class="kc">false</span></code></dd>
+</dl>
+
+If enabled, Masonry will size the width of the container to the nearest column. When enabled, Masonry will measure the width of the container's parent element, not the width of the container. This option is ideal for centering Masonry layouts.
+
+[See Demo: Centered](../demos/centered.html).
+
+## isResizable
+
+<dl class="clearfix">
+  <dt><code>isResizable</code></dt>
+  <dd class="option-type">Boolean</dd>
+  <dd class="default"><code><span class="kc">true</span></code></dd>
+</dl>
+
+Triggers layout logic when browser window is resized.
+
+## isRTL
+
+<dl class="clearfix">
+  <dt><code>isRTL</code></dt>
+  <dd class="option-type">Boolean</dd>
+  <dd class="default"><code><span class="kc">false</span></code></dd>
+</dl>
+
+Enables right-to-left layout for languages like Hebrew and Arabic.
+
+[See Demo: Right-to-left](../demos/right-to-left.html).
+
+## itemSelector
+
+<dl class="clearfix">
+  <dt><code>itemSelector</code></dt>
+  <dd class="option-type">String</dd>
+</dl>
+
+Filters item elements to selector. If not set, Masonry defaults to using the child elements of the container.
+
+**Recommended** to avoid Masonry using any other hidden elements in its layout logic.
+
+{% highlight javascript %}
+
+$('#container').masonry({ itemSelector: '.box' });
+
+{% endhighlight %}

data/spec/_posts/docs/2011-05-03-methods.mdown

@@ -0,0 +1,155 @@
+---
+
+title: Methods
+category: docs
+layout: default
+toc:
+  - { title: appended, anchor: appended }
+  - { title: destroy, anchor: destroy }
+  - { title: layout, anchor: layout }
+  - { title: option, anchor: option }
+  - { title: reloadItems, anchor: reloaditems }
+  - { title: reload, anchor: reload }
+  - { title: remove, anchor: remove }
+
+---
+
+Masonry offers several methods to extend functionality. Masonry's methods follow the jQuery UI pattern.
+
+{% highlight javascript %}
+
+$('#container').masonry( 'methodName', [optionalParameters] )
+
+{% endhighlight %}
+
+
+## appended
+
+{% highlight javascript %}
+
+.masonry( 'appended', $content, isAnimatedFromBottom )
+
+{% endhighlight %}
+
+Triggers `layout` on item elements that have been appended to the container.
+
+[See Demo: Adding items](../demos/adding-items.html).
+
+{% highlight javascript %}
+
+var $boxes = $('<div class="box"/><div class="box"/><div class="box"/>');
+$('#container').append( $boxes ).masonry( 'appended', $boxes );
+
+{% endhighlight %}
+
+Setting the `isAnimatedFromBottom` argument to <code><span class="kc">true</span></code> will enable the newly appended items to be animated from the bottom, if animation is enabled.
+
+{% highlight javascript %}
+
+$('#container').append( $boxes ).masonry( 'appended', $boxes, true );
+
+{% endhighlight %}
+
+
+The `appended` method is ideal to use Masonry with Infinite Scroll, in its callback.
+
+[See Demo: Infinite Scroll](../demos/infinite-scroll.html).
+
+{% highlight javascript %}
+
+
+var $container = $('#container');
+$container.infinitescroll({
+    // infinite scroll options...
+  },
+  // trigger Masonry as a callback
+  function( newElements ) {
+    var $newElems = $( newElements );
+    $container.masonry( 'appended', $newElems );
+  }
+);
+
+{% endhighlight %}
+
+
+## destroy
+
+{% highlight javascript %}
+
+.masonry( 'destroy' )
+
+{% endhighlight %}
+
+Removes Masonry functionality completely. Returns element back to pre-initialized state.
+
+## layout
+
+{% highlight javascript %}
+
+.masonry( 'layout', $items, callback )
+
+{% endhighlight %}
+
+Positions specified item elements in layout.
+
+`layout` will only position specified elements, and those elements will be positioned at the end of layout. Whereas `.masonry()` will position all items in the Masonry instance.
+
+## option
+
+{% highlight javascript %}
+
+.masonry( 'option', options )
+
+{% endhighlight %}
+
+Sets options for plugin instance. Unlike passing options through `.masonry()`, using the `option` method will not trigger layout.
+
+{% highlight javascript %}
+
+// set multiple options
+.masonry( 'option', { columnWidth: 120, isAnimated: false } )
+
+{% endhighlight %}
+
+
+## reloadItems
+
+{% highlight javascript %}
+
+.masonry( 'reloadItems' )
+
+{% endhighlight %}
+
+Re-collects all item elements in their current order in the DOM.  
+
+## reload
+
+{% highlight javascript %}
+
+.masonry( 'reload' )
+
+{% endhighlight %}
+
+Convenience method for triggering `reloadItems` then `.masonry()`. Useful for prepending or inserting items.
+
+[See Demo: Adding items](../demos/adding-items.html).
+
+{% highlight javascript %}
+
+var $boxes = $('<div class="box"/><div class="box"/><div class="box"/>');
+$('#container').prepend( $boxes ).masonry( 'reload' );
+
+{% endhighlight %}
+
+## remove
+
+{% highlight javascript %}
+
+.masonry( 'remove', $items )
+
+{% endhighlight %}
+
+Removes specified item elements from Masonry instance and the DOM.
+
+
+