turn.js/readme.md
2012-02-08 12:17:26 -05:00

53 lines
999 B
Markdown
Executable File

turn.js
=========
### The awesome paper-like effect made for HTML5
Turn.js is a plugin for jQuery that adds a beautiful transition similar
to real pages in a book or magazine. It works in all modern browsers including
touch devices.
#### Example
**CSS code:**
<pre>
#magazine{
width:800px;
height:400px;
}
#magazine .turn-page{
width:400px;
height:400px;
background-color:#ccc;
}
</pre>
**HTML code:**
<pre>
&lt;div id=<span class="string">'magazine'</span>&gt;
&lt;div&gt; <span class="text">Page 1</span> &lt;/div&gt;
&lt;div&gt; <span class="text">Page 2</span> &lt;/div&gt;
&lt;div&gt; <span class="text">Page 3</span> &lt;/div&gt;
&lt;/div&gt;
</pre>
**JavaScript code:**
<pre>
$('#magazine').turn({page: 1, shadows: true, acceleration: true});
</pre>
#### Requeriments
jQuery 1.7 or later
[Full documentation on turnjs.com/#reference](https://github.com/blasten/turn.js/wiki/Reference)
* * *
turn.js is licensed under MIT license.
[turnjs.com](http://www.turnjs.com/)