Example: Alignment Support

This example shows how you can use Overlay's extended positioning support to align or center the overlay either in the viewport or relative to another node on the page. You can specify any one of 9 points (top-left, top-right, bottom-left, bottom-right, top-center, bottom-center, left-center, right-center, center) to align on both the Overlay and the node/viewport it is being aligned to.

Nibh
#align1
Arcu
Congue
Purus
Quam
Neque
Aiquam
Eget
Etiam

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc pretium quam eu mi varius pulvinar. Duis orci arcu, ullamcorper sit amet, luctus ut, interdum ac, quam. Pellentesque euismod. Nam tincidunt, purus in ultrices Nevada landscape (id='align2')

congue, urna neque posuere arcu, aliquam tristique purus sapien id nulla. Etiam rhoncus nulla at leo. Cras scelerisque nisl in nibh. Sed eget odio.

#align3

Morbi elit elit, porta a, convallis sit amet, rhoncus non, felis. Mauris nulla pede, pretium eleifend, porttitor at, rutrum id, orci. Quisque non urna. Nulla aliquam rhoncus est.

Aligned XY Overlay Positioning - align and center Support

Setting Up The YUI Instance

As with the "Basic XY Positioning" example, to create an instance of an Overlay on your page, the only module you need to request is the overlay module. The overlay module will pull in the widget, widget-stack, widget-position, widget-position-align, widget-position-constrain and widget-stdmod extensions it uses.

YUI({...}).use("overlay", function(Y) {
    // We'll write example code here, where we have a Y.Overlay class available.
});

Using the overlay module, will also pull down the default CSS required for overlay, on top of which we only need to add our required look/feel CSS for the example.

Note: be sure to add the yui3-skin-sam classname to the page's <body> element or to a parent element of the widget in order to apply the default CSS skin. See Understanding Skinning.

<body class="yui3-skin-sam"> <!-- You need this skin class -->

Instantiating The Overlay

For this example, we'll instantiate an Overlay, as we did for the "Basic XY Positioning" example, however we'll set the content for the Overlay sections using the headerContent and bodyContent attributes. We won't create a footer section for this overlay:

/* Create Overlay from script, this time. With no footer */
var overlay = new Y.Overlay({
    width:"16em",
    headerContent: 'Aligned Overlay<span id="step"></span>',
    bodyContent: '<div class="descr"></div><div id="alignment"></div>',
    zIndex:2
});

/* Render it as a child of the #overlay-align element */
overlay.render("#overlay-align");

Since the Overlay is created from script, and doesn't currently exist in the document, we pass the overlay.render() method a selector query ("#overlay-align") for the node under which we want the Overlay to be rendered in the DOM. If we leave out this argument to render (or if the selector query doesn't bring back a node), the Overlay will be rendered to the current document's body element.

Aligning the overlay

The WidgetPositionAlign extension used to create the overlay class adds the align and centered attributes to the Overlay, which can be used to align or center the Overlay relative to another element on the page (or the viewport).

The align attribute accepts as a value an object literal with the following properties:

node

The node to which the Widget is to be aligned. If set to null, or not provided, the Overlay is aligned to the viewport

points

A two element array, defining the two points on the Overlay and node which are to be aligned. The first element is the point on the Overlay, and the second element is the point on the node (or viewport). Supported alignment points are defined as static properties on the WidgetPositionAlign extension.

e.g. [Y.WidgetPositionAlign.TR, Y.WidgetPositionAlign.TL] aligns the Top-Right corner of the Overlay with the Top-Left corner of the node/viewport, and [Y.WidgetPositionAlign.CC, Y.WidgetPositionAlign.TC] aligns the Center of the Overlay with the Top-Center edge of the node/viewport.

The centered property can either by set to true to center the Overlay in the viewport, or set to a selector string or node reference to center the Overlay in a particular node.

The example loops around a list of 6 alignment configurations, as the "Align Next" button is clicked:

/* Setup local variable for Y.WidgetPositionAlign, since we use it multiple times */
var a = Y.WidgetPositionAlign;

...

/* Align top-left corner of overlay, with top-right corner of #align1 */
overlay.set("align", {node:"#align1", 
                      points:[a.TL, a.TR]});

/* Center overlay in #align2 */
overlay.set("centered", "#align2");

/* Align top-center edge of overlay with bottom-center edge of #align3 */
overlay.set("align", {node:"#align3", 
                      points:[a.TC, a.BC]});

/* Align right-center edge of overlay with right-center edge of viewport */
overlay.set("align", {points:[a.RC, a.RC]});

/* Center overlay in viewport */
overlay.set("centered", true);

/* Center in #overlay-align (example box) */
overlay.set("align", {node:"#overlay-align", 
                      points:[a.CC, a.CC]});

CSS: Overlay Look/Feel

As mentioned in the "Basic XY Positioning" example, the overlay.css Sam Skin file (build/overlay/assets/skins/sam/overlay.css) provides the default functional CSS for the overlay. Namely the CSS rules to hide the overlay, and position it absolutely. However there's no default out-of-the-box look/feel applied to the Overlay widget.

The example provides it's own look and feel for the Overlay, by defining rules for the content box, header and body sections:

/* Overlay Look/Feel */
.yui3-overlay-content {
    background-color: #ECEFFB;  
    border: 1px solid #9EA8C6;
    border-radius: 3px;
    box-shadow: 3px 3px 5px rgba(0, 0, 0, 0.25);
}

.yui3-overlay-content .yui3-widget-hd {
    background-color: #B6BFDA;  
    color: #30418C;
    font-size: 120%;
    font-weight: bold;
    padding: 0.2em 0.5em 0.3em;
    border-radius: 2px 2px 0 0;
}

.yui3-overlay-content .yui3-widget-bd {
    padding: 0.4em 0.6em 0.5em;
}

.yui3-overlay-content .yui3-widget-ft {
    background-color:#DFE3F5;
    padding: 0.4em 0.6em 0.5em;
    border-radius: 0 0 2px 2px;
}

Complete Example Source

<div class="overlay-example" id="overlay-align">
    
    <div class="example-head">
        <button type="button" class="button" id="align">View Next Alignment</button>
        <pre class="code" id="alignment"></pre>
    </div>
    <div class="yui3-g">
        <div class="yui3-u-1-8">
            <ul class="nav">
                <li>Nibh</li>
                <li id="align1" class="align-box"><span class="title">#align1</span></li>
                <li>Arcu</li>
                <li>Congue</li>
                <li>Purus</li>
                <li>Quam</li>
                <li>Neque</li>
                <li>Aiquam</li>
                <li>Eget</li>
                <li>Etiam</li>
            </ul>
        </div>
        <div class="yui3-u-5-8">
            <div class="content">
                Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc pretium quam 
                eu mi varius pulvinar. Duis orci arcu, ullamcorper sit amet,
                luctus ut, 
                interdum ac, quam. Pellentesque euismod. Nam tincidunt, purus in ultrices 
                <img id="align2" class="align-box" src="../assets/overlay/img/nevada.png" alt="Nevada landscape (id='align2')"/>
                congue, urna neque posuere arcu, aliquam tristique purus sapien id nulla. 
                Etiam rhoncus nulla at leo. Cras scelerisque nisl in nibh. Sed eget odio.
            </div> 
        </div>
        <div class="yui3-u-1-4">
            <div class="content">
                <div id="align3" class="align-box"><span class="title">#align3</span></div>
                Morbi elit elit, porta a, convallis sit amet, rhoncus non, felis. Mauris 
                nulla pede, pretium eleifend, porttitor at, rutrum id, orci. Quisque non 
                urna. Nulla aliquam rhoncus est.
            </div>
        </div>
        
    
    </div>
</div>

<script type="text/javascript">
YUI().use("overlay", function(Y) {

    /* Create Overlay from script, this time. No footer */
    var overlay = new Y.Overlay({
        width:"16em",
        headerContent: 'Aligned Overlay<span id="step"></span>',
        bodyContent: '<div class="descr"></div>',
        zIndex:2
    });

    /* Render it to #overlay-align element */
    overlay.render("#overlay-align");

    var alignment = Y.one("#alignment");
    var stepNumber = Y.one("#step");
    var descr = Y.one('.yui3-widget-bd .descr');

    /* Setup local variable for Y.WidgetPositionAlign, since we use it multiple times */
    var a = Y.WidgetPositionAlign,
        declareA = "var a = Y.WidgetPositionAlign; // Local variable<br><br>",
        dontDeclareA = "<br><br>";

    var steps = [
        function() {
            /* Align top-left corner of overlay, with top-right corner of #align1 */
            alignment.setHTML(declareA + 'overlay.set("align", {<br>    node: "#align1",<br>    points: [a.TL, a.TR]<br>});');
            descr.setHTML('Align top-left corner of overlay, with top-right corner of #align1');
            Y.one('#align1').addClass('aligned-to');
            overlay.set("align", {node:"#align1", points: [a.TL, a.TR]});
        },
        function() {
            /* Center overlay in #align2 */
            alignment.setHTML(dontDeclareA + 'overlay.set("centered", "#align2");');
            descr.setHTML('Center overlay in #align2 <br>(an image)');
            Y.one('#align2').addClass('aligned-to');
            overlay.set("centered", "#align2");
        },
        function() {
            /* Align top-center edge of overlay with bottom-center edge of #align3 */
            alignment.setHTML(declareA + 'overlay.set("align", {<br>    node: "#align3",<br>    points: [a.TC, a.BC]<br>});');
            descr.setHTML('Align top-center edge of overlay with bottom-center edge of #align3');
            Y.one('#align3').addClass('aligned-to');
            overlay.set("align", {node:"#align3", points:[a.TC, a.BC]});
        },
        function() {
            /* Align right-center edge of overlay with right-center edge of viewport */
            alignment.setHTML(declareA + 'overlay.set("align", {<br>    points: [a.RC, a.RC]<br>});');
            descr.setHTML('Align right-center edge of overlay with right-center edge of viewport');
            overlay.set("align", {points:[a.RC, a.RC]});
        },
        function() {
            /* Center overlay in viewport */
            alignment.setHTML(dontDeclareA + 'overlay.set("centered", true);');
            descr.setHTML('Center overlay in viewport');
            overlay.set("centered", true);
        },
        function() {
            /* Center in #overlay-align */
            alignment.setHTML(declareA + 'overlay.set("align", {<br>    node: "#overlay-align",<br>    points: [a.CC, a.CC]<br>});');
            descr.setHTML('Center in #overlay-align');
            Y.one('#overlay-align').addClass('aligned-to');
            overlay.set("align", {node:"#overlay-align", points:[a.CC, a.CC]});
        }
    ];

    var step = 0;
    var totalSteps = steps.length;

    function alignNext() {
        stepNumber.setHTML((step+1) + " of " + totalSteps);
        Y.all('.aligned-to').removeClass('aligned-to');
        steps[step]();
        step = (++step)%(totalSteps);
    }

    alignNext();

    Y.on("click", alignNext, "#align");
});
</script>