Main Page: Difference between revisions

From Turn.js Documentation
Jump to navigation Jump to search
No edit summary
 
(114 intermediate revisions by the same user not shown)
Line 1: Line 1:
:{|  
Turn.js is a library that will make your content look like a real book or magazine with just HTML content. It uses HTML5 and CSS3 to perform the effects, reason why it works nicely on touch devices such as iOS devices (iPad, iPhone, iPod) and Android devices.
! scope="col"  width="225" | Options
 
! scope="col" width="225" | Properties
Turn.js takes all the advantages of having real HTML content over flash content. Besides the feeling of native content (selectable content, no third-party contextual menus), it's possible to add advertisement codes, HTML5 videos, tooltips, images, maps, forms, keep tracking of every page and combine them with hundreds of clever libraries made for the Web.
! scope="col" width="225" | Methods
 
! scope="col" width="225" | Events
==Let's take a look at how it works==
! scope="col" width="225" | CSS Classes
 
1. We create the HTML
<pre class="xml">
<div id="flipbook">
  <div class="hard"> Turn.js </div>
  <div class="hard"></div>
  <div> Page 1 </div>
  <div> Page 2 </div>
  <div> Page 3 </div>
  <div> Page 4 </div>
  <div class="hard"></div>
  <div class="hard"></div>
</div>
</pre>
2. Then the JavaScript part
<pre class="javascript">
$("#flipbook").turn({
  width: 400,
  height: 300,
  autoCenter: true
});
</pre>
 
[http://jsfiddle.net/blasten/A9a7E Here's the result on jsFiddle]
 
== Turn.js 4th release==
Turn.js 4th release has over 10 different performance improvements and more than 20 new features.  The improvements were mainly focused on making the effects much more fluent and smoother as well as reducing memory consumption when using the browser's GPU and storing elements in the DOM tree.  It also supports old browsers such as IE8 by adding a new file called turn.html4.js, which has the exact same API (methods, properties) but it deals with the effects in a different way on HTML4-based browsers.
 
==Flipbook==
 
Turn is the built-in jQuery plugin that comes with the turn.js development kit, which allows you to create flipbooks. These are the options, properties, methods, events and CSS classes available in turn.js 4.0.9 release.
 
:{| class="simple"
! scope="col"  width="225" | [[Turn Options|Options]]
! scope="col" width="225" |  [[Turn Properties|Properties]]
! scope="col" width="225" |  [[Turn Methods|Methods]]
! scope="col" width="225" |  [[Turn Events|Events]]
! scope="col" width="225" |  [[Turn CSS|CSS Classes]]


|-
|-
| valign="top" |
| valign="top" |
* [[Option: autoCenter|acceleration]]
* [[Option: acceleration|acceleration]]
* [[Option: autoCenter|autoCenter]]
* [[Option: autoCenter|autoCenter]]
* [[Option: direction|direction]]
* [[Option: display|display]]
* [[Option: display|display]]
* [[Option: display|duration]]
* [[Option: duration|duration]]
* [[Option: gradients|gradients]]
* [[Option: gradients|gradients]]
* [[Option: height|height]]
* [[Option: height|height]]
* [[Option: inclination|inclination]]
* [[Option: elevation|elevation]]
* [[Option: page|page]]
* [[Option: page|page]]
* [[Option: pages|pages]]
* [[Option: pages|pages]]
* [[Option: turnCorners|turnCorners]]
* [[Option: when|when]]
* [[Option: when|when]]
* [[Option: width|width]]
* [[Option: width|width]]
Line 22: Line 61:


* [[Property: animating|animating]]
* [[Property: animating|animating]]
* [[Property: direction|direction]]
* [[Property: display|display]]
* [[Property: display|display]]
* [[Property: disabled|disabled]]
* [[Property: disabled|disabled]]
Line 37: Line 77:
* [[Method: center|center]]
* [[Method: center|center]]
* [[Method: destroy|destroy]]
* [[Method: destroy|destroy]]
* [[Method: direction|direction]]
* [[Method: display|display]]
* [[Method: display|display]]
* [[Method: disable|disable]]
* [[Method: disable|disable]]
Line 42: Line 83:
* [[Method: next|next]]
* [[Method: next|next]]
* [[Method: is|is]]
* [[Method: is|is]]
* [[Method: options|options]]
* [[Method: page|page]]
* [[Method: page|page]]
* [[Method: pages|pages]]
* [[Method: pages|pages]]
Line 51: Line 93:
* [[Method: size|size]]
* [[Method: size|size]]
* [[Method: stop|stop]]
* [[Method: stop|stop]]
* [[Method: version|version]]
* [[Method: zoom|zoom]]
* [[Method: zoom|zoom]]


Line 73: Line 116:
* [[Class: .p|.p[0-9]+]]
* [[Class: .p|.p[0-9]+]]
* [[Class: .shadow|.shadow]]
* [[Class: .shadow|.shadow]]
* [[.Class: .sheet|sheet]]
* [[Class: .sheet|.sheet]]
 
|}
 
==Zoom Viewport==
 
To implement the new zoom function, a new component is available since turn.js 4.0.2 to define the viewport of the pages when zoomed in. There's an article about [[How to add zoom to turn.js|how to add zoom to turn.js]].
 
:{| class="simple" width="600"
! scope="col"  width="225" | [[Zoom Options | Options]]
! scope="col" width="225" | [[Zoom Properties | Properties]]
! scope="col" width="225" |  [[Zoom Methods | Methods]]
! scope="col" width="225" | [[Zoom Events | Events]]
 
|-
| valign="top" |
* [[Option: easeFunction|easeFunction]]
* [[Zoom Option: duration|duration]]
* [[Option: max|max]]
* [[Option: flipbook|flipbook]]
* [[Zoom Option: when|when]]
 
| valign="top" |
 
* [[Property: value|value]]
 
 
| valign="top"  |
 
* [[Method: zoomIn|zoomIn]]
* [[Method: zoomOut|zoomOut]]
 


| valign="top"  |
* [[Event: change|change]]
* [[Event: doubleTap|doubleTap]]
* [[Event: resize|resize]]
* [[Event: swipeLeft|swipeLeft]]
* [[Event: swipeRight|swipeRight]]
* [[Event: tap|tap]]
* [[Event: zoomIn|zoomIn]]
* [[Event: zoomOut|zoomOut]]
|}
|}
==Scissors==
Scissors is literally a scissor that cuts a page in two parts, so that you can have double pages made entirely in HTML5  and split them into two pages.
[[Scissor|Read more about Scissor]]
__NOTOC__

Latest revision as of 06:20, 26 November 2012

Turn.js is a library that will make your content look like a real book or magazine with just HTML content. It uses HTML5 and CSS3 to perform the effects, reason why it works nicely on touch devices such as iOS devices (iPad, iPhone, iPod) and Android devices.

Turn.js takes all the advantages of having real HTML content over flash content. Besides the feeling of native content (selectable content, no third-party contextual menus), it's possible to add advertisement codes, HTML5 videos, tooltips, images, maps, forms, keep tracking of every page and combine them with hundreds of clever libraries made for the Web.

Let's take a look at how it works

1. We create the HTML

<div id="flipbook">
  <div class="hard"> Turn.js </div> 
  <div class="hard"></div>
  <div> Page 1 </div>
  <div> Page 2 </div>
  <div> Page 3 </div>
  <div> Page 4 </div>
  <div class="hard"></div>
  <div class="hard"></div>
</div>

2. Then the JavaScript part

$("#flipbook").turn({
  width: 400,
  height: 300,
  autoCenter: true
});

Here's the result on jsFiddle

Turn.js 4th release

Turn.js 4th release has over 10 different performance improvements and more than 20 new features. The improvements were mainly focused on making the effects much more fluent and smoother as well as reducing memory consumption when using the browser's GPU and storing elements in the DOM tree. It also supports old browsers such as IE8 by adding a new file called turn.html4.js, which has the exact same API (methods, properties) but it deals with the effects in a different way on HTML4-based browsers.

Flipbook

Turn is the built-in jQuery plugin that comes with the turn.js development kit, which allows you to create flipbooks. These are the options, properties, methods, events and CSS classes available in turn.js 4.0.9 release.

Options Properties Methods Events CSS Classes


Zoom Viewport

To implement the new zoom function, a new component is available since turn.js 4.0.2 to define the viewport of the pages when zoomed in. There's an article about how to add zoom to turn.js.

Options Properties Methods Events



Scissors

Scissors is literally a scissor that cuts a page in two parts, so that you can have double pages made entirely in HTML5 and split them into two pages.

Read more about Scissor