index.mustache revision 701f9f21edb316e858b8444130651516c5d4a21b
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<div class="intro">
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>The TabView widget is a UI control that enables the user switch between content panels.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive{{>getting-started}}
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <h2 id="anatomy">Anatomy of a TabView</h2>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <h3>Minimum Markup Requirement</h3>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>A <code>TabView</code> consists of a list of links that target a content element.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>The basic markup needed to create from HTML is the following:</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<div id="demo">
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li><a href="#foo">foo</a></li>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li><a href="#bar">bar</a></li>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li><a href="#baz">baz</a></li>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="foo">foo content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="bar">bar content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="baz">baz content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <h3 id="rendered-markup">Rendered Markup</h3>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<p>After a <code>TabView</code> is rendered, the final markup becomes:
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<div class="yui3-widget yui3-tabview">
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="demo" class="yui3-tabview-content">
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <ul class="yui3-tabview-list">
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li class="yui3-tab yui3-widget yui3-tab-selected">
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <a href="#foo" class="yui3-tab-label yui3-tab-content">foo</a>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li class="yui3-tab yui3-widget">
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <a href="#bar" class="yui3-tab-label yui3-tab-content">bar</a>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li class="yui3-tab yui3-widget">
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <a href="#baz" class="yui3-tab-label yui3-tab-content">baz</a>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div class="yui3-tabview-panel">
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="foo" class="yui3-tab-panel">foo content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="bar" class="yui3-tab-panel">bar content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="baz" class="yui3-tab-panel">baz content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <h2 id="instantiating">Creating and Configuring a TabView</h2>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>A <code>TabView</code> instance can be created from existing markup on the page, or dynamically
6aada32e978e09cc60d52cb05ae4cee91b676da1slive using JavaScript.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <h3 id="from-markup">From Existing Markup</h3>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>To create from existing markup, first conform to the basic markup pattern, then create a
6aada32e978e09cc60d52cb05ae4cee91b676da1slive new <code>TabView</code> instance, pointing to the existing <code>srcNode</code>, and render.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<div id="demo">
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li><a href="#foo">foo</a></li>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li><a href="#bar">bar</a></li>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <li><a href="#baz">baz</a></li>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="foo">foo content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="bar">bar content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="baz">baz content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1sliveYUI().use('tabview', function(Y) {
6aada32e978e09cc60d52cb05ae4cee91b676da1slive var tabview = new Y.TabView({
6aada32e978e09cc60d52cb05ae4cee91b676da1slive srcNode: '#demo'
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <h3 id="from-js">From JavaScript</h3>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>To create purely from JavaScript, all that is required is passing the <code>TabView</code>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive constructor a list of <code>children</code> containing their respective <code>label</code>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive and <content> attributes, and call render. As with all YUI <code>Widget</code>s,
6aada32e978e09cc60d52cb05ae4cee91b676da1slive render takes an optional container to render into, or defaults to the <code>body</code> element.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<div id="demo"></div>
6aada32e978e09cc60d52cb05ae4cee91b676da1sliveYUI().use('tabview', function(Y) {
6aada32e978e09cc60d52cb05ae4cee91b676da1slive var tabview = new Y.TabView({
6aada32e978e09cc60d52cb05ae4cee91b676da1slive children: [{
6aada32e978e09cc60d52cb05ae4cee91b676da1slive label: 'foo',
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive content: '<p>foo content</p>'
6aada32e978e09cc60d52cb05ae4cee91b676da1slive label: 'bar',
6aada32e978e09cc60d52cb05ae4cee91b676da1slive content: '<p>bar content</p>'
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive label: 'baz',
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive content: '<p>baz content</p>'
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <h2 id="skinning">Skinning TabView</h2>
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <p>The <code>TabView</code> comes with a basic skin by default. This can be easily
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive customized using the rich set of <a href="#rendered-markup">classNames</a>.</p>
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <p>For a more polished look and feel, we also ship with the "sam skin", which can
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive be applied by adding the <code>yui3-skin-sam</code> className to some ancestor:</p>
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive<body class="yui3-skin-sam">
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive<div id="demo">
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <li><a href="#foo">foo</a></li>
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <li><a href="#bar">bar</a></li>
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <li><a href="#baz">baz</a></li>
2df40fa998d3364133c4dd29eb395f5ae70dfc1fslive <div id="foo">foo content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="bar">bar content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <div id="baz">baz content</div>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <h2 id="events">TabView Events</h2>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>TabViews fire the following events during operation:</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <th>Event</th>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <th>When</th>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <th>Payload</th>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td><code>addChild</code></td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td>a Tab is added to the TabView</td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td><code>child, index</code></td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td><code>removeChild</code></td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td>a Tab is removed from the TabView</td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td><code>child, index</code></td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td><code>selectionChange</code></td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td>the selected tab changes</td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td><code>prevVal, newVal</code></td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td><code>render</code></td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td>a Tabview is rendered</td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td>Normal change event signature (<code>newVal</code>, <code>prevVal</code>, etc). When dragging, extra event property <code>ddEvent : (drag:drag event)</code> is added</td>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>This is not an exhaustive list. See the <a href="{{apiDocs}}/module_tabview.html">API docs</a> for a complete listing.</p>