YUI Library Home

Site Search (YDN & YUIBlog):

# YUI Library Examples: Browser History Manager: TabView Control

# Browser History Manager: TabView Control

This example demonstrates how to use the Browser History Manager to remember which tabs have been visited with the TabView widget and dynamically update it when the user presses the browser's back/forward buttons.

View example in new window.

Tab One Content

Tab Two Content

Tab Three Content

## Basic markup

In our example, the TabView widget relies on the following markup:

<div id="demo" class="yui-navset yui-navset-top"> <ul class="yui-nav"> <li><a href="#tab1"><em>Tab One Label</em></a></li> <li title="active" class="selected"><a href="#tab2"><em>Tab Two Label</em></a></li> <li title="" class=""><a href="#tab3"><em>Tab Three Label</em></a></li> </ul> <div class="yui-content"> <div id="tab1"><p>Tab One Content</p></div> <div id="tab2"><p>Tab Two Content</p></div> <div id="tab3"><p>Tab Three Content</p></div> </div> </div>

## Add the markup required by the Browser History Manager

<iframe id="yui-history-iframe" src="assets/blank.html"></iframe> <input id="yui-history-field" type="hidden">

This markup should be inserted right after the opening `body` tag.

## Import the source files and dependencies

In our example, we need the Event Utility, DOM Utility, TabView Widget, and the Browser History Manager:

<link rel="stylesheet" type="text/css" href="tabview.css"/> <script src="yahoo-dom-event.js"></script> <script src="element.js"></script> <script src="tabview.js"></script> <script src="history.js"></script>

## Design your application

In our simple example, we have only one module, represented by the TabView widget. We will refer to this module using the identifier "tabview". The state of the TabView module will be represented using the string `"tab"` followed by the selected tab index (e.g. `"tab2"` if the third tab is selected)

## Retrieve the initial state of the TabView module

Use the `YAHOO.util.History.getBookmarkedState` method and default to the first tab:

var bookmarkedTabViewState = YAHOO.util.History.getBookmarkedState("tabview"); var initialTabViewState = bookmarkedTabViewState || "tab0";

## Register the TabView module

Use the `YAHOO.util.History.register` method, passing in the TabView module identifier, the initial state of the TabView module, and the callback function that will be called when the state of the TabView module has changed:

YAHOO.util.History.register("tabview", initialTabViewState, function (state) { // Select the tab according to the "state" parameter: tabView.set("activeIndex", state.substr(3)); });

## Write the code that initializes your application

var tabView; function initTabView () { // Instantiate the TabView control... tabView = new YAHOO.widget.TabView("demo"); tabView.addListener("activeTabChange", handleTabViewActiveTabChange); }

## Use the Browser History Manager `onReady` method

Use the Browser History Manager `onReady` method to instantiate the TabView widget. Also, retrieve the current state of the TabView module, and use that state to select the right tab (the current state may be different from the initial state under certain circumstances - see the User's Guide)

YAHOO.util.History.onReady(function () { var currentState; initTabView(); // This is the tricky part... The onLoad event is fired when the user // comes back to the page using the back button. In this case, the // actual tab that needs to be selected corresponds to the last tab // selected before leaving the page, and not the initially selected tab. // This can be retrieved using getCurrentState: currentState = YAHOO.util.History.getCurrentState("tabview"); tabView.set("activeIndex", currentState.substr(3)); });

## Add history entries

A new history entry must be added every time the user selects a tab. Use the TabView widget's `activeTabChange` event handler (set to `handleTabViewActiveTabChange` - see above):

function handleTabViewActiveTabChange (e) { var newState, currentState; newState = "tab" + this.getTabIndex(e.newValue); try { currentState = YAHOO.util.History.getCurrentState("tabview"); // The following test is crucial. Otherwise, we end up circling forever. // Indeed, YAHOO.util.History.navigate will call the module onStateChange // callback, which will call tabView.set, which will call this handler // and it keeps going from here... if (newState != currentState) { YAHOO.util.History.navigate("tabview", newState); } } catch (e) { tabView.set("activeIndex", newState.substr(3)); } }

## Initialize the Browser History Manager

Simply call `YAHOO.util.History.initialize`, passing in the id of the input field and IFrame we inserted in our static markup:

// Initialize the browser history management library. try { YAHOO.util.History.initialize("yui-history-field", "yui-history-iframe"); } catch (e) { // The only exception that gets thrown here is when the browser is // not supported (Opera, or not A-grade) Degrade gracefully. initTabView(); }

## Configuration for This Example

You can load the necessary JavaScript and CSS for this example from Yahoo's servers. Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured.

### Browser History Manager Examples:

- Simple Navigation Bar
- TabView Control
- Calendar Control
- Multiple Modules
- Integrating Browser History Manager with Server-side Pagination and Sorting (included with examples for DataTable Control)

### More Browser History Manager Resources:

- User's Guide (external)
- API Documentation
- Cheat Sheet PDF (external)

Copyright © 2010 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings