| |
| |
| |
| <h2 id="introduction">Introduction</h2> |
| <p>The Material Design Lite (MDL) <strong>layout</strong> component is a comprehensive approach to page layout that uses MDL development tenets, allows for efficient use of MDL components, and automatically adapts to different browsers, screen sizes, and devices.</p> |
| <p>Appropriate and accessible layout is a critical feature of all user interfaces, regardless of a site's content or function. Page design and presentation is therefore an important factor in the overall user experience. See the layout component's <a href="http://www.google.com/design/spec/layout/principles.html">Material Design specifications page</a> for details.</p> |
| <p>Use of MDL layout principles simplifies the creation of scalable pages by providing reusable components and encourages consistency across environments by establishing recognizable visual elements, adhering to logical structural grids, and maintaining appropriate spacing across multiple platforms and screen sizes. MDL layout is extremely powerful and dynamic, allowing for great consistency in outward appearance and behavior while maintaining development flexibility and ease of use.</p> |
| <h3 id="to-include-a-basic-mdl-layout-component-">To include a basic MDL <strong>layout</strong> component:</h3> |
| <p> 1. Code a <code><div></code> element. This is the "outer" div that holds the entire layout.</p> |
| <pre><code class="lang-html"><div> |
| </div> |
| </code></pre> |
| <blockquote> |
| <p><strong>Note:</strong> The layout cannot be applied directly on the <code><body></code> element. Always create a nested <code><div></code> element.</p> |
| </blockquote> |
| <p> 2. Add MDL classes as indicated, separated by spaces, to the div using the <code>class</code> attribute.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| </div> |
| </code></pre> |
| <p> 3. Inside the div, code a <code><header></code> element. This holds the header row with navigation links that is displayed on large screens, and the menu icon that opens the navigation drawer for smaller screens. Add the MDL class to the header using the <code>class</code> attribute.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| </header> |
| </div> |
| </code></pre> |
| <p> 4. Inside the header, add a <code><div></code> to produce the menu icon, and include the MDL class as indicated. The div has no content of its own.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| </header> |
| </div> |
| </code></pre> |
| <p> 5. Still inside the header, add another <code><div></code> to hold the header row's content, and include the MDL class as indicated.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| </div> |
| </header> |
| </div> |
| </code></pre> |
| <p> 6. Inside the header row div, add a span containing the layout title, and include the MDL class as indicated.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| </div> |
| </header> |
| </div> |
| </code></pre> |
| <p> 7. Following the span, add a <code><div></code> to align the header's navigation links to the right, and include the MDL class as indicated.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| <div class="mdl-layout-spacer"></div> |
| </div> |
| </header> |
| </div> |
| </code></pre> |
| <p> 8. Following the spacer div, add a <code><nav></code> element to contain the header's navigation links, and include the MDL class as indicated. Inside the nav, add one anchor <code><a></code> element for each header link, and include the MDL class as indicated. This completes the layout's header.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Nav link 1</a> |
| <a class="mdl-navigation__link" href="#">Nav link 2</a> |
| <a class="mdl-navigation__link" href="#">Nav link 3</a> |
| </nav> |
| </div> |
| </header> |
| </div> |
| </code></pre> |
| <p> 9. Following the header, add a <code><div></code> element to hold the slide-out drawer's content, and add the MDL class as indicated. The drawer appears automatically on smaller screens, and may be opened with the menu icon on any screen size.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Nav link 1</a> |
| <a class="mdl-navigation__link" href="#">Nav link 2</a> |
| <a class="mdl-navigation__link" href="#">Nav link 3</a> |
| </nav> |
| </div> |
| </header> |
| <div class="mdl-layout__drawer"> |
| </div> |
| </div> |
| </code></pre> |
| <p> 10. Inside the drawer div, add a span containing the layout title (this should match the title in step 5), and include the MDL class as indicated.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Nav link 1</a> |
| <a class="mdl-navigation__link" href="#">Nav link 2</a> |
| <a class="mdl-navigation__link" href="#">Nav link 3</a> |
| </nav> |
| </div> |
| </header> |
| <div class="mdl-layout__drawer"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| </div> |
| </div> |
| </code></pre> |
| <p> 11. Following the span, add a <code><nav></code> element to contain the drawer's navigation links, and one anchor <code><a></code> element for each drawer link (these should match the links in step 7), and include the MDL classes as indicated. This completes the layout's drawer.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Nav link 1</a> |
| <a class="mdl-navigation__link" href="#">Nav link 2</a> |
| <a class="mdl-navigation__link" href="#">Nav link 3</a> |
| </nav> |
| </div> |
| </header> |
| <div class="mdl-layout__drawer"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Nav link 1</a> |
| <a class="mdl-navigation__link" href="#">Nav link 2</a> |
| <a class="mdl-navigation__link" href="#">Nav link 3</a> |
| </nav> |
| </div> |
| </div> |
| </code></pre> |
| <p> 12. Finally, following the drawer div, add a <code><main></code> element to hold the layout's primary content, and include the MDL class as indicated. Inside that element, add your desired content.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Nav link 1</a> |
| <a class="mdl-navigation__link" href="#">Nav link 2</a> |
| <a class="mdl-navigation__link" href="#">Nav link 3</a> |
| </nav> |
| </div> |
| </header> |
| <div class="mdl-layout__drawer"> |
| <span class="mdl-layout__title">Simple Layout</span> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Nav link 1</a> |
| <a class="mdl-navigation__link" href="#">Nav link 2</a> |
| <a class="mdl-navigation__link" href="#">Nav link 3</a> |
| </nav> |
| </div> |
| <main class="mdl-layout__content"> |
| <p>Content</p> |
| <p>Goes</p> |
| <p>Here</p> |
| </main> |
| </div> |
| </code></pre> |
| <p>The layout component is ready for use.</p> |
| <h4 id="examples">Examples</h4> |
| <p>A layout with a fixed header for larger screens and a collapsible drawer for smaller screens.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout-icon"></div> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Material Design Lite</span> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Hello</a> |
| <a class="mdl-navigation__link" href="#">World.</a> |
| <a class="mdl-navigation__link" href="#">How</a> |
| <a class="mdl-navigation__link" href="#">Are</a> |
| <a class="mdl-navigation__link" href="#">You?</a> |
| </nav> |
| </div> |
| </header> |
| <div class="mdl-layout__drawer"> |
| <span class="mdl-layout__title">Material Design Lite</span> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Hello</a> |
| <a class="mdl-navigation__link" href="#">World.</a> |
| <a class="mdl-navigation__link" href="#">How</a> |
| <a class="mdl-navigation__link" href="#">Are</a> |
| <a class="mdl-navigation__link" href="#">You?</a> |
| </nav> |
| </div> |
| <main class="mdl-layout__content"> |
| <div>Content</div> |
| </main> |
| </div> |
| </code></pre> |
| <p>The same layout with a non-fixed header that scrolls with the content.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout"> |
| <header class="mdl-layout__header mdl-layout__header--scroll"> |
| <img class="mdl-layout-icon"></img> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Material Design Lite</span> |
| <div class="mdl-layout-spacer"></div> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Hello</a> |
| <a class="mdl-navigation__link" href="#">World.</a> |
| <a class="mdl-navigation__link" href="#">How</a> |
| <a class="mdl-navigation__link" href="#">Are</a> |
| <a class="mdl-navigation__link" href="#">You?</a> |
| </nav> |
| </div> |
| </header> |
| <div class="mdl-layout__drawer"> |
| <span class="mdl-layout__title">Material Design Lite</span> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Hello</a> |
| <a class="mdl-navigation__link" href="#">World.</a> |
| <a class="mdl-navigation__link" href="#">How</a> |
| <a class="mdl-navigation__link" href="#">Are</a> |
| <a class="mdl-navigation__link" href="#">You?</a> |
| </nav> |
| </div> |
| <main class="mdl-layout__content"> |
| <div>Content</div> |
| </main> |
| </div> |
| </code></pre> |
| <p>A layout with a fixed drawer that serves as sidebar navigation on larger screens. The drawer collapses and the menu icon is displayed on smaller screens.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer"> |
| <header class="mdl-layout__header"> |
| <div class="mdl-layout__header-row"> |
| <span class="mdl-layout__title">Fixed drawer layout demo</span> |
| </div> |
| </header> |
| <div class="mdl-layout__drawer"> |
| <span class="mdl-layout__title">Material Design Lite</span> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Hello</a> |
| <a class="mdl-navigation__link" href="#">World.</a> |
| <a class="mdl-navigation__link" href="#">How</a> |
| <a class="mdl-navigation__link" href="#">Are</a> |
| <a class="mdl-navigation__link" href="#">You?</a> |
| </nav> |
| </div> |
| <main class="mdl-layout__content"> |
| <div>Content</div> |
| </main> |
| </div> |
| </code></pre> |
| <p>A layout with a fixed drawer but no header.</p> |
| <pre><code class="lang-html"><div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer"> |
| <div class="mdl-layout__drawer"> |
| <span class="mdl-layout__title">Material Design Lite</span> |
| <nav class="mdl-navigation"> |
| <a class="mdl-navigation__link" href="#">Hello</a> |
| <a class="mdl-navigation__link" href="#">World.</a> |
| <a class="mdl-navigation__link" href="#">How</a> |
| <a class="mdl-navigation__link" href="#">Are</a> |
| <a class="mdl-navigation__link" href="#">You?</a> |
| </nav> |
| </div> |
| <main class="mdl-layout__content"> |
| <div>Content</div> |
| </main> |
| </div> |
| </code></pre> |
| <h2 id="configuration-options">Configuration options</h2> |
| <p>The MDL CSS classes apply various predefined visual and behavioral enhancements to the layout. The table below lists the available classes and their effects.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>MDL class</th> |
| <th>Effect</th> |
| <th>Remarks</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>mdl-layout</code></td> |
| <td>Defines container as an MDL component</td> |
| <td>Required on outer div element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-js-layout</code></td> |
| <td>Assigns basic MDL behavior to layout</td> |
| <td>Required on outer div element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__header</code></td> |
| <td>Defines container as an MDL component</td> |
| <td>Required on header element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout-icon</code></td> |
| <td>Used for adding an application icon. Gets concealed by menu icon if both are visible.</td> |
| <td>Goes on optional icon element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__header-row</code></td> |
| <td>Defines container as MDL header row</td> |
| <td>Required on header content div</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__title</code></td> |
| <td>Defines layout title text</td> |
| <td>Required on layout title span</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout-spacer</code></td> |
| <td>Used to align elements inside a header or drawer, by growing to fill remaining space. Commonly used for aligning elements to the right.</td> |
| <td>Goes on optional div following layout title</td> |
| </tr> |
| <tr> |
| <td><code>mdl-navigation</code></td> |
| <td>Defines container as MDL navigation group</td> |
| <td>Required on nav element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-navigation__link</code></td> |
| <td>Defines anchor as MDL navigation link</td> |
| <td>Required on header and/or drawer anchor elements</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__drawer</code></td> |
| <td>Defines container as MDL layout drawer</td> |
| <td>Required on drawer div element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__content</code></td> |
| <td>Defines container as MDL layout content</td> |
| <td>Required on main element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__header--scroll</code></td> |
| <td>Makes the header scroll with the content</td> |
| <td>Optional; goes on header element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout--fixed-drawer</code></td> |
| <td>Makes the drawer always visible and open in larger screens</td> |
| <td>Optional; goes on outer div element (not drawer div element)</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout--fixed-header</code></td> |
| <td>Makes the header always visible, even in small screens</td> |
| <td>Optional; goes on outer div element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout--no-drawer-button</code></td> |
| <td>Does not display a drawer button</td> |
| <td>Optional; goes on <code>mdl-layout</code> element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout--no-desktop-drawer-button</code></td> |
| <td>Does not display a drawer button in desktop mode</td> |
| <td>Optional; goes on <code>mdl-layout</code> element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout--large-screen-only</code></td> |
| <td>Hides an element on smaller screens</td> |
| <td>Optional; goes on any descendant of <code>mdl-layout</code></td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout--small-screen-only</code></td> |
| <td>Hides an element on larger screens</td> |
| <td>Optional; goes on any descendant of <code>mdl-layout</code></td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__header--waterfall</code></td> |
| <td>Allows a "waterfall" effect with multiple header lines</td> |
| <td>Optional; goes on header element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__header--waterfall-hide-top</code></td> |
| <td>Hides the top rather than the bottom rows on a waterfall header</td> |
| <td>Optional; goes on header element. Requires <code>mdl-layout__header--waterfall</code></td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__header--transparent</code></td> |
| <td>Makes header transparent (draws on top of layout background)</td> |
| <td>Optional; goes on header element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__header--seamed</code></td> |
| <td>Uses a header without a shadow</td> |
| <td>Optional; goes on header element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__tab-bar</code></td> |
| <td>Defines container as an MDL tab bar</td> |
| <td>Required on div element inside header (tabbed layout)</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__tab</code></td> |
| <td>Defines anchor as MDL tab link</td> |
| <td>Required on tab bar anchor elements</td> |
| </tr> |
| <tr> |
| <td><code>is-active</code></td> |
| <td>Defines tab as default active tab</td> |
| <td>Optional; goes on tab bar anchor element and associated tab section element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__tab-panel</code></td> |
| <td>Defines container as tab content panel</td> |
| <td>Required on tab section elements</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout__tab-manual-switch</code></td> |
| <td>Disables tab switching when clicking on tab separators. Useful for disabling default behavior and setting up your own event listeners.</td> |
| <td>Optional; goes on tab bar element</td> |
| </tr> |
| <tr> |
| <td><code>mdl-layout--fixed-tabs</code></td> |
| <td>Uses fixed tabs instead of the default scrollable tabs</td> |
| <td>Optional; goes on outer div element (not div inside header)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |