UNPKG

stylie.tabs

Version:

100% width tabbed content with some example media queries for smaller screens.

571 lines (184 loc) 7.74 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: StylieTabs</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: StylieTabs</h1> <section> <header> <h2> StylieTabs </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="StylieTabs"><span class="type-signature"></span>new StylieTabs<span class="signature">(el, options)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>A module that represents a StylieTabs object, a componentTab is a page composition tool.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>el</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>element of tab container</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>configuration options</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-author">Author:</dt> <dd class="tag-author"> <ul> <li>Yaw Joseph Etse</li> </ul> </dd> <dt class="tag-copyright">Copyright:</dt> <dd class="tag-copyright"><ul class="dummy"><li>Copyright (c) 2015 Typesettin. All rights reserved.</li></ul></dd> <dt class="tag-license">License:</dt> <dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="stylie.tabs.js.html">stylie.tabs.js</a>, <a href="stylie.tabs.js.html#line14">line 14</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Requires</h3> <ul> <li>module:util-extent</li> <li>module:util</li> <li>module:events</li> </ul> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>module default configuration</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="stylie.tabs.js.html">stylie.tabs.js</a>, <a href="stylie.tabs.js.html#line40">line 40</a> </li></ul></dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="_init"><span class="type-signature"></span>_init<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>initializes tabs and shows current tab.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="stylie.tabs.js.html">stylie.tabs.js</a>, <a href="stylie.tabs.js.html#line51">line 51</a> </li></ul></dd> </dl> <h5>Fires:</h5> <ul> <li>event:tabsInitialized</li> </ul> </dd> <dt> <h4 class="name" id="_initEvents"><span class="type-signature"></span>_initEvents<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>handle tab click events.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="stylie.tabs.js.html">stylie.tabs.js</a>, <a href="stylie.tabs.js.html#line71">line 71</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="_show"><span class="type-signature"></span>_show<span class="signature">(idx)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Sets up a new lintotype component.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>idx</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>tab to show</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="stylie.tabs.js.html">stylie.tabs.js</a>, <a href="stylie.tabs.js.html#line87">line 87</a> </li></ul></dd> </dl> <h5>Fires:</h5> <ul> <li>event:tabsShowIndex</li> </ul> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="StylieTabs.html">StylieTabs</a></li></ul> </nav> <br clear="both"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed May 06 2015 13:46:05 GMT-0400 (EDT) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>