<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Panel</title>
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="../../build/yui/yui-min.js"></script>
</head>
<body>
<!--
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
-->
<div id="doc">
<div id="hd">
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
</div>
<a href="#toc" class="jump">Jump to Table of Contents</a>
<h1>Panel</h1>
<div class="yui3-g">
<div class="yui3-u-3-4">
<div id="main">
<div class="content"><div class="intro">
<p>
Panel is a Widget that mimics the functionality of a regular OS window. It is similar to Overlay, with added functionality to support modality, event listeners on which to auto-hide and auto-focus, header/footer button support and skins. Panel does not have any implementation code of it's own. It implements a set of extensions that provide certain sets of functionality. The <a href="../widget/widget-build.html">"Creating Custom Widget Classes"</a> example shows how you can use these extensions to build classes which mix and match some of the above features.
</p>
</div>
<h2 id="getting-started">Getting Started</h2>
<p>
To include the source files for Panel and its dependencies, first load
the YUI seed file if you haven't already loaded it.
</p>
<pre class="code prettyprint"><script src="http://yui.yahooapis.com/3.10.3/build/yui/yui-min.js"></script></pre>
<p>
Next, create a new YUI instance for your application and populate it with the
modules you need by specifying them as arguments to the <code>YUI().use()</code> method.
YUI will automatically load any dependencies required by the modules you
specify.
</p>
<pre class="code prettyprint"><script>
// Create a new YUI instance and populate it with the required modules.
YUI().use('panel', function (Y) {
// Panel is available and ready for use. Add implementation
// code here.
});
</script></pre>
<p>
For more information on creating YUI instances and on the
<a href="http://yuilibrary.com/yui/docs/api/classes/YUI.html#method_use"><code>use()</code> method</a>, see the
documentation for the <a href="../yui/index.html">YUI Global Object</a>.
</p>
<p>
<strong>Note:</strong> be sure to add the <code>yui3-skin-sam</code> classname to the
page's <code><body></code> element or to a parent element of the widget in order to apply
the default CSS skin. See <a href="http://yuilibrary.com/yui/docs/tutorials/skins/">Understanding Skinning</a>.
</p>
<pre class="code prettyprint"><body class="yui3-skin-sam"> <!-- You need this skin class --></pre>
<h2 id="creating-a-panel">Creating a Panel</h2>
<p>
This simple example will create a Panel with default functionality. By default, a Panel is rendered with a "close" button added to the header, with modality disabled, and will be hidden if the <code>esc</code> key or "close" button is pressed.
</p>
<pre class="code prettyprint lang-javascript">YUI().use('panel', function (Y) {
var panel = new Y.Panel({
srcNode : '#myPanelContent',
width : 400,
centered: true,
render : true
});
});</pre>
<h2 id="modal-panel">Modal Panel</h2>
<p>
A Panel is not modal by default. This functionality can be changed through the <code>modal</code> attribute, either during instantiation or later through the <code>set()</code> method.
</p>
<pre class="code prettyprint lang-javascript">YUI().use('panel', function (Y) {
var panel = new Y.Panel({
srcNode: '#myPanelContent',
width : 400,
modal : true // Make the Panel modal
});
panel.render();
// Optionally, we could have written:
// panel.set('modal', true);
});</pre>
<p>
Panels can be nested in one another, and have different modal behavior. For instance, a modal Panel may launch a non-modal Panel on top of it. The <a href="http://yuilibrary.com/yui/docs/api/classes/WidgetModality.html"><code>WidgetModality</code></a> extension takes care of nesting behavior so no extra code is required for the implementer. Refer to the examples for more information.
</p>
<h2 id="choosing-when-to-focus-and-hide">Choosing When to Focus and Hide</h2>
<p>
By default, a modal Panel will return focus to itself if anything else on the page receives focus or is clicked. On the other hand, clicking the "close" button, or pressing the <code>esc</code> key will hide it. Both of these options can be configured as needed through the <code>hideOn</code> and <code>focusOn</code> attributes.
</p>
<p>
The following code snippet shows how to change the default "hide" behavior. Instead of hiding when the <code>esc</code> key is pressed, the Panel hides whenever something outside its <code>boundingBox</code> is pressed, or when a certain element on the page (with an id of <code>anotherNode</code>) is clicked.
</p>
<pre class="code prettyprint lang-javascript">YUI().use('panel', function (Y) {
var panel = new Y.Panel({
srcNode : '#myPanelContent',
width : 400,
centered: true,
modal : false,
render : true,
// The `hideOn` Attribute takes an array of objects with a required
// `eventName` property, and two optional properties:
// `node` and `keyCode`.
hideOn: [
{
// When we don't specify a `node`,
// it defaults to the `boundingBox` of this Panel instance.
eventName: 'clickoutside'
},
{
// Listen to click events on the `node` that was specified.
node : Y.one('#anotherNode'),
eventName: 'click'
}
]
});
});</pre>
<p>
Similarly, the <code>focusOn</code> attribute can be changed to configure the default focus behavior.
</p>
<pre class="code prettyprint lang-javascript">var panel = new Y.Panel({
srcNode : '#myPanelContent',
width : 400,
centered: true,
modal : false,
render : true,
// The `focusOn` Attribute takes an array of objects with a required
// `eventName` property, and optionally the `node` property.
focusOn: [
{
// When we don't specify a `node`,
// it defaults to the `boundingBox` of this Panel instance.
eventName: 'clickoutside'
},
{
// Listen to click events on the `node` that was specified.
node : Y.one('#anotherNode'),
eventName: 'click'
}
]
});
});</pre>
<p>
To simply get rid of the default behavior, we could just set the <code>focusOn</code> and <code>hideOn</code> attributes to empty Arrays.
</p>
<h2 id="headerfooter-button-support">Header/Footer Button Support</h2>
<p>
Panel supports header/footer buttons through the <a href="http://yuilibrary.com/yui/docs/api/classes/WidgetButtons.html"><code>WidgetButtons</code></a> and <a href="http://yuilibrary.com/yui/docs/api/classes/WidgetStdMod.html"><code>WidgetStdMod</code></a> extensions. By default, it comes with a "close" button represented by the "x" in the top-right corner of the header. As a developer, you can easily add/remove buttons to the header or the footer, change the style of existing buttons, or change the markup that is used to render the buttons.
</p>
<pre class="code prettyprint lang-javascript">YUI().use('panel', function (Y) {
function doSomethingElse() {
// ...
}
var panel = new Y.Panel({
srcNode : '#myPanelContent',
width : 400,
centered: true,
// Make changes to the buttons through the `buttons` attribute,
// which takes an Array of Objects.
buttons: [
{
// Each object has a `value` property,
// which can be text or an HTML string.
value: "Okay",
// The `action` property takes the Function that should be
// executed on a click event.
action: function(e) {
e.preventDefault();
panel.hide();
doSomethingElse();
},
// The `section` property tells where to render the button and
// should be `Y.WidgetStdMod.HEADER` or `Y.WidgetStdMod.FOOTER`.
section: Y.WidgetStdMod.FOOTER
// Optional `classNames` property to add CSS classes to the
// button Node.
// optional `href` property if you are linking to an URL.
}
]
});
panel.render();
});</pre>
<p>
If you want to append buttons to the ones that are already present within the Panel, you can use the <code>addButton()</code> method.
</p>
<pre class="code prettyprint lang-javascript">var cancelButton = {
value : 'Cancel',
action: function(e) {
e.preventDefault();
// ...
},
// 'header', 'footer' or Y.WidgetStdMod.HEADER also work here.
section: Y.WidgetStdMod.FOOTER
};
panel.addButton(cancelButton);</pre>
<h2 id="notes-regarding-older-browsers">Notes Regarding Older Browsers</h2>
<p>
Panel is tested across the A-grade browser set according to the <a href="http://yuilibrary.com/yui/docs/tutorials/gbs/" alt="Graded Browser Support">GBS Browser Test Baseline</a> as of July 2011.
</p>
<p>
However, developers implementing Panel and other components which rely on <code>z-index</code> support in IE6 and IE7 should be aware of the concept of <a href="https://developer.mozilla.org/en/Understanding_CSS_z-index/Stacking_context_example_2" alt="Stacking Context in IE">stacking context</a>. Essentially, when setting the <code>z-index</code> of the widget, you should ensure that the Widget's parent does not have a lower <code>z-index</code>.
</p>
</div>
</div>
</div>
<div class="yui3-u-1-4">
<div class="sidebar">
<div id="toc" class="sidebox">
<div class="hd">
<h2 class="no-toc">Table of Contents</h2>
</div>
<div class="bd">
<ul class="toc">
<li>
<a href="#getting-started">Getting Started</a>
</li>
<li>
<a href="#creating-a-panel">Creating a Panel</a>
</li>
<li>
<a href="#modal-panel">Modal Panel</a>
</li>
<li>
<a href="#choosing-when-to-focus-and-hide">Choosing When to Focus and Hide</a>
</li>
<li>
<a href="#headerfooter-button-support">Header/Footer Button Support</a>
</li>
<li>
<a href="#notes-regarding-older-browsers">Notes Regarding Older Browsers</a>
</li>
</ul>
</div>
</div>
<div class="sidebox">
<div class="hd">
<h2 class="no-toc">Examples</h2>
</div>
<div class="bd">
<ul class="examples">
<li data-description="Shows how to instantiate multiple Panel instances, and use nested modality to interact with a Datatable.">
<a href="panel-form.html">Creating a Modal Form</a>
</li>
<li data-description="Shows how to create a panel that animates as it is shown and hidden">
<a href="panel-animate.html">Creating an Animated Panel</a>
</li>
<li data-description="Shows how to create a dialog instance that can be reused for multiple messages and confirmations.">
<a href="dialog.html">Creating a Reusable Dialog</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script>
YUI.Env.Tests = {
examples: [],
project: '../assets',
assets: '../assets/panel',
name: 'panel',
title: 'Panel',
newWindow: '',
auto: false
};
YUI.Env.Tests.examples.push('panel-form');
YUI.Env.Tests.examples.push('panel-animate');
YUI.Env.Tests.examples.push('dialog');
</script>
<script src="../assets/yui/test-runner.js"></script>
</body>
</html>