Browse Source

Layouts -> Layout Modes, use ## for headers

Jekyll/maruku automatically add id attrs
pull/14/head
David DeSandro 14 years ago
parent
commit
89e7bd22ac
  1. 2
      _includes/layout-options.html
  2. 32
      _posts/docs/2010-12-03-options.mdown
  3. 16
      _posts/docs/2010-12-04-methods.mdown
  4. 32
      _posts/docs/2010-12-05-layout-modes.mdown
  5. 2
      _posts/examples/2010-12-29-layout-modes.html
  6. 4
      css/style.css

2
_includes/layout-options.html

@ -1,4 +1,4 @@
<h3>Layouts</h3>
<h3>Layout Modes</h3>
<ul id="layouts" class="option-set floated clearfix">
<li><a href="#masonry" class="selected">masonry</a></li>

32
_posts/docs/2010-12-03-options.mdown

@ -13,7 +13,7 @@ body_class: option-def
<dd class="default">Default</dd>
</dl>
<h2 id="animationEngine">animationEngine</h2>
## animationEngine
<dl class="clearfix">
<dt><code>animationEngine</code></dt>
@ -30,7 +30,7 @@ Determines the jQuery method to apply styles, `.css()` or `.animate()`. Useful f
+ `'css'`: Isotope uses `.css()`
+ `'jquery'`: Isotope uses `.animate()`
<h2 id="animationOptions">animationOptions</h2>
## animationOptions
<dl class="clearfix">
<dt><code>animationOptions</code></dt>
@ -40,7 +40,7 @@ Determines the jQuery method to apply styles, `.css()` or `.animate()`. Useful f
When jQuery is the animation engine, these options will be used in <code>.animate()</code>. See the [jQuery API for animate options](http://api.jquery.com/animate/#animate-properties-options) for details.
**Example:**
### Example
{% highlight javascript %}
@ -54,7 +54,7 @@ $('#container').isotope({
{% endhighlight %}
<h2 id="containerClass">containerClass</h2>
## containerClass
<dl class="clearfix">
<dt><code>containerClass</code></dt>
@ -64,7 +64,7 @@ $('#container').isotope({
The class applied to the container element.
<h2 id="filter">filter</h2>
## filter
<dl class="clearfix">
<dt><code>filter</code></dt>
@ -73,7 +73,7 @@ The class applied to the container element.
Setting a filter with show item elements that match the selector, and hide elements that do not match.
<h2 id="getSortData">getSortData</h2>
## getSortData
<dl class="clearfix">
<dt><code>getSortData</code></dt>
@ -82,7 +82,7 @@ Setting a filter with show item elements that match the selector, and hide eleme
An object containing one or several methods to retrieve data for Sorting. The methods receive one parameter (`$elem` in the example below) which is a jQuery object representing each item element. The methods need to return a value.
**Example**
### Example
{% highlight javascript %}
@ -102,7 +102,7 @@ $('#container').isotope({
{% endhighlight %}
<h2 id="hiddenClass">hiddenClass</h2>
## hiddenClass
<dl class="clearfix">
<dt><code>hiddenClass</code></dt>
@ -112,7 +112,7 @@ $('#container').isotope({
The class applied to item elements hidden by Filtering.
<h2 id="hiddenStyle">hiddenStyle</h2>
## hiddenStyle
<dl class="clearfix">
<dt><code>hiddenStyle</code></dt>
@ -122,7 +122,7 @@ The class applied to item elements hidden by Filtering.
The style applied to item elements hidden by Filtering.
<h2 id="itemSelector">itemSelector</h2>
## itemSelector
<dl class="clearfix">
<dt><code>itemSelector</code></dt>
@ -131,7 +131,7 @@ The style applied to item elements hidden by Filtering.
Restricts Isotope item elements to selector.
<h2 id="layoutMode">layoutMode</h2>
## layoutMode
<dl class="clearfix">
<dt><code>layoutMode</code></dt>
@ -139,7 +139,7 @@ Restricts Isotope item elements to selector.
<dd class="default"><code><span class="s1">'masonry'</span></code></dd>
</dl>
<h2 id="resizeable">resizeable</h2>
## resizeable
<dl class="clearfix">
<dt><code>resizeable</code></dt>
@ -149,7 +149,7 @@ Restricts Isotope item elements to selector.
Triggers layout logic when browser window is resized.
<h2 id="sortAscending">sortAscending</h2>
## sortAscending
<dl class="clearfix">
<dt><code>sortAscending</code></dt>
@ -159,7 +159,7 @@ Triggers layout logic when browser window is resized.
Used with sorting. If true, items are sorted ascending: "1, 2, 3" or "A, B, C...". If false, items are sorted descending "Z, Y, X" or "9, 8, 7...".
<h2 id="sortBy">sortBy</h2>
## sortBy
<dl class="clearfix">
<dt><code>sortBy</code></dt>
@ -170,7 +170,7 @@ The property name of the method within the `getSortData` option to sort item ele
Looking at the `getSortData` example above, valid values would be `'symbol'`, `'number'`, or `'name'`.
<h2 id="visibleStyle">visibleStyle</h2>
## visibleStyle
<dl class="clearfix">
<dt><code>visibleStyle</code></dt>
@ -180,7 +180,7 @@ Looking at the `getSortData` example above, valid values would be `'symbol'`, `'
The style applied to item elements made visible by Filtering.
<h2 id="layout-specific">Layout-specific options</h2>
## Layout-specific options
In addition the general options listed above, certain layout modes each have their own options. In order to avoid conflict, these options are set with an option that matches the name of the layout mode.

16
_posts/docs/2010-12-04-methods.mdown

@ -7,7 +7,7 @@ layout: doc
---
<h2 id="addItems">addItems</h2>
## addItems
{% highlight javascript %}
@ -17,7 +17,7 @@ layout: doc
Adds elements to the pool of item elements of the container, but does sort, filter or layout.
<h2 id="appended">appended</h2>
## appended
{% highlight javascript %}
@ -29,7 +29,7 @@ Adds elements via `addItems` method, then triggers `layout` just for those new e
Useful for Infinite Scroll.
<h2 id="destroy">destroy</h2>
## destroy
{% highlight javascript %}
@ -39,7 +39,7 @@ Useful for Infinite Scroll.
Removes Isotope functionality completely. Returns element back to pre-init state.
<h2 id="insert">insert</h2>
## insert
{% highlight javascript %}
@ -49,7 +49,7 @@ Removes Isotope functionality completely. Returns element back to pre-init state
Appends elements to container, adds items to via `addItems` method, and then triggers `reLayout` method so new elements are properly filtered, sorted and laid-out.
<h2 id="layout">layout</h2>
## layout
{% highlight javascript %}
@ -59,7 +59,7 @@ Appends elements to container, adds items to via `addItems` method, and then tri
Arranges new elements to the end of the layout.
<h2 id="option">option</h2>
## option
{% highlight javascript %}
@ -69,7 +69,7 @@ Arranges new elements to the end of the layout.
Modifies options for plugin instance.
<h2 id="reLayout">reLayout</h2>
## reLayout
{% highlight javascript %}
@ -80,7 +80,7 @@ Modifies options for plugin instance.
Resets layout properties and lays-out every item element.
<h2 id="resize">resize</h2>
## resize
{% highlight javascript %}

32
_posts/docs/2010-12-05-layouts.mdown → _posts/docs/2010-12-05-layout-modes.mdown

@ -1,6 +1,6 @@
---
title: Layouts
title: Layout Modes
category: docs
layout: doc
body_class: option-def
@ -9,6 +9,8 @@ body_class: option-def
Isotope is versatile in that it can accommodate multiple layout modes. You can set and change the layout mode via the `layoutMode` option.
[**See Example: Layout Modes**](../examples/layout-modes.html)
### Example
{% highlight javascript %}
@ -19,11 +21,11 @@ $('#container').isotope({ layoutMode: 'fitRows' });
Six layout modes are built into Isotope.
<h2 id="masonry">masonry</h2>
## masonry
masonry is the default layout mode for Isotope. Item elements are arranged intelligently within a grid. For each item element, the script calculates the next best fit for the item within the grid.
**Options**
### Options
<dl class="clearfix">
<dt><code>columnWidth</code></dt>
@ -32,7 +34,7 @@ masonry is the default layout mode for Isotope. Item elements are arranged intel
The width of one column in the grid. If no value is set for `columnWidth`, default is the width of the first item element.
**Example**
### Example
{% highlight javascript %}
@ -44,15 +46,15 @@ $('#container').isotope({
{% endhighlight %}
<h2 id="fitRows">fitRows</h2>
## fitRows
Item elements are arranged into rows. Similar to what you would expect from a layout that uses `float: left`
<h2 id="cellsByRow">cellsByRow</h2>
## cellsByRow
A grid layout. The grid is defined by two options, `columnWidth` and `rowHeight`.
**Options**
### Options
<dl class="clearfix">
<dt><code>columnWidth</code></dt>
@ -63,7 +65,7 @@ A grid layout. The grid is defined by two options, `columnWidth` and `rowHeight`
<dd class="option-type">Integer</dd>
</dl>
**Example**
### Example
{% highlight javascript %}
@ -77,11 +79,11 @@ $('#container').isotope({
{% endhighlight %}
<h2 id="masonryHorizontal">masonryHorizontal</h2>
## masonryHorizontal
The horizontal equivalent of masonry layout. Instead of progressing top-to-bottom, masonryHorizontal layout will progress left-to-right. Item elements are arranged intelligently within a grid. For each item element, the script calculates the next best fit for the item within the grid.
**Options**
### Options
<dl class="clearfix">
<dt><code>rowHeight</code></dt>
@ -90,7 +92,7 @@ The horizontal equivalent of masonry layout. Instead of progressing top-to-botto
The width of one column in the grid. If no value is set for `rowHeight`, default is the height of the first item element.
**Example**
### Example
{% highlight javascript %}
@ -102,15 +104,15 @@ $('#container').isotope({
{% endhighlight %}
<h2 id="fitRows">fitColumns</h2>
## fitColumns
Item elements are arranged into columns. The horizontal equivalent of fitRows. Columns progress from left to right. Items within those columns are arranged top-to-bottom.
<h2 id="cellsByRow">cellsByColumn</h2>
## cellsByColumn
A grid layout. The grid is defined by two options, `columnWidth` and `rowHeight`. The horizontal equivalent of cellsByRow.
**Options**
### Options
<dl class="clearfix">
<dt><code>columnWidth</code></dt>
@ -121,7 +123,7 @@ A grid layout. The grid is defined by two options, `columnWidth` and `rowHeight`
<dd class="option-type">Integer</dd>
</dl>
**Example**
### Example
{% highlight javascript %}

2
_posts/examples/2010-12-29-layouts.html → _posts/examples/2010-12-29-layout-modes.html

@ -1,6 +1,6 @@
---
layout: nil
title: Layouts
title: Layout Modes
category: examples
---
<!doctype html>

4
css/style.css

@ -333,6 +333,10 @@ pre, code {
line-height: 1.6em;
}
h3#options {
padding-bottom: 0;
}
.option-def dl {
/* margin-top: 1.8em;*/
/* padding-top: 0.5em;*/

Loading…
Cancel
Save