YUI Library Home

Site Search (YDN & YUIBlog):

# YUI Library Examples: Layout Manager: Full Page Layout

# Layout Manager: Full Page Layout

This example shows how to build a full page layout.

View example in new window.

## Using the Layout Manager for a full page layout

We can make a full page layout by omitting the first parameter to the Layout Manager's constructor.

var layout = new YAHOO.widget.Layout({ }); layout.render();

## Setting up the Layout Units

Each area of the layout (top, right, bottom, left and center) is made up of a `LayoutUnit`.

The only required unit is the center unit. It will be the one that is fluid when styled.

We can setup these units by passing them into the unit array configuration option.

var layout = new YAHOO.widget.Layout({ units: [ { position: 'top' }, { position: 'right' }, { position: 'bottom' }, { position: 'left' }, { position: 'center' } ] }); layout.render();

## Configuring a unit

Each `LayoutUnit` has its own configuration settings. In the example below we, will show the following options:

- `position`: The position that this unit will take in the Layout.
- `header`: The string to use for the Header of the unit.
- `width`: The width (in pixels) that the unit will take up in the layout.
- `resize`: Should the unit be resizable.
- `gutter`: The gutter applied to the unit's wrapper, before the content.
- `footer`: An id or string to use as the footer of the unit.
- `collapse`: Should the unit be collapable. (places an icon in the header)
- `scroll`: Should the unit's body have scroll bars if the body content is larger than the display area.
- `body`: An id or string to be used as the unit's body
- `animate`: Should be animate the expand and collapse moments.

See the API docs for more info on LayoutUnit options.

### The HTML for the body

<div id="right1"> <b>Right 1</b> <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Suspendisse justo nibh, pharetra at, adipiscing ullamcorper.</p> <!-- SNIPPED --> </div>

### The configuration for the Right unit

{ position: 'right', header: 'Right', width: 300, resize: true, gutter: '5px', footer: 'Footer', collapse: true, scroll: true, body: 'right1', animate: true }

## Full Example Source

<div id="top1"> <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Suspendisse justo nibh, pharetra at, adipiscing ullamcorper.</p> </div> <div id="bottom1"> <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Suspendisse justo nibh, pharetra at, adipiscing ullamcorper.</p> </div> <div id="right1"> <b>Right 1</b> <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Suspendisse justo nibh, pharetra at, adipiscing ullamcorper.</p> <!-- SNIPPED --> </div> <div id="left1"> <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Suspendisse justo nibh, pharetra at, adipiscing ullamcorper.</p> <!-- SNIPPED --> </div> <div id="center1"> <p id="toggle"><a href="#" id="tRight">Toggle Right</a><a href="#" id="tLeft">Toggle Left</a> <a href="#" id="closeLeft">Close Left</a><a href="#" id="padRight">Add Gutter to Right</a></p> <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Suspendisse justo nibh, pharetra at, .</p> <!-- SNIPPED --> </div> (function() { var Dom = YAHOO.util.Dom, Event = YAHOO.util.Event; Event.onDOMReady(function() { var layout = new YAHOO.widget.Layout({ units: [ { position: 'top', height: 50, body: 'top1', header: 'Top', gutter: '5px', collapse: true, resize: true }, { position: 'right', header: 'Right', width: 300, resize: true, gutter: '5px', footer: 'Footer', collapse: true, scroll: true, body: 'right1', animate: true }, { position: 'bottom', header: 'Bottom', height: 100, resize: true, body: 'bottom1', gutter: '5px', collapse: true }, { position: 'left', header: 'Left', width: 200, resize: true, body: 'left1', gutter: '5px', collapse: true, close: true, collapseSize: 50, scroll: true, animate: true }, { position: 'center', body: 'center1' } ] }); layout.on('render', function() { layout.getUnitByPosition('left').on('close', function() { closeLeft(); }); }); layout.render(); Event.on('tLeft', 'click', function(ev) { Event.stopEvent(ev); layout.getUnitByPosition('left').toggle(); }); Event.on('tRight', 'click', function(ev) { Event.stopEvent(ev); layout.getUnitByPosition('right').toggle(); }); Event.on('padRight', 'click', function(ev) { Event.stopEvent(ev); var pad = prompt('CSS gutter to apply: ("2px" or "2px 4px" or any combination of the 4 sides)', layout.getUnitByPosition('right').get('gutter')); layout.getUnitByPosition('right').set('gutter', pad); }); var closeLeft = function() { var a = document.createElement('a'); a.href = '#'; a.innerHTML = 'Add Left Unit'; Dom.get('closeLeft').parentNode.appendChild(a); Dom.setStyle('tLeft', 'display', 'none'); Dom.setStyle('closeLeft', 'display', 'none'); Event.on(a, 'click', function(ev) { Event.stopEvent(ev); Dom.setStyle('tLeft', 'display', 'inline'); Dom.setStyle('closeLeft', 'display', 'inline'); a.parentNode.removeChild(a); layout.addUnit(layout.get('units')[3]); layout.getUnitByPosition('left').on('close', function() { closeLeft(); }); }); }; Event.on('closeLeft', 'click', function(ev) { Event.stopEvent(ev); layout.getUnitByPosition('left').close(); }); }); })();

## 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.

### Layout Manager Examples:

- Full Page Layout
- Layout inside a resizable Panel
- Using a Layout with Grids CSS
- Nesting a layout
- Layout with Menu Controls
- Simple Application
- Complex Application
- Skinning a Layout

### More Layout 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