Directory

← Back

app-layout

App layout elements

Author

Rating

Popularity

<100

Published on NPM Build status Published on webcomponents.org

App Layout

A collection of elements, along with guidelines and templates that can be used to structure your app’s layout.

What is inside

Elements

  • app-box - A container element that can have scroll effects - visual effects based on scroll position.

  • app-drawer - A navigation drawer that can slide in from the left or right.

  • app-drawer-layout - A wrapper element that positions an app-drawer and other content.

  • app-grid - A helper class useful for creating responsive, fluid grid layouts using custom properties.

  • app-header - A container element for app-toolbars at the top of the screen that can have scroll effects - visual effects based on scroll position.

  • app-header-layout - A wrapper element that positions an app-header and other content.

  • app-toolbar - A horizontal toolbar containing items that can be used for label, navigation, search and actions.

Templates

The templates are a means to define, illustrate and share best practices in App Layout. Pick a template and customize it:

Patterns

Sample code for various UI patterns:

  • Transform navigation: As more screen space is available, side navigation can transform into tabs. (Demo - Source)

  • Expand Card: Content cards may expand to take up more horizontal space. (Demo - Source)

  • Material Design Responsive Toolbar: Toolbar changes its height and padding to adapt mobile screen size. (Demo - Source)

Users

Here are some web apps built with App Layout:

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/app-layout

In an html file

<html>
  <head>
    <script type="module">
      import '@polymer/app-layout/app-layout.js';
    </script>
  </head>
  <body>
    <app-header reveals>
      <app-toolbar>
        <div main-title>My app</div>
      </app-toolbar>
    </app-header>
    <app-drawer id="drawer" swipe-open></app-drawer>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/app-layout/app-layout.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <app-header reveals>
        <app-toolbar>
          <div main-title>My app</div>
        </app-toolbar>
      </app-header>
      <app-drawer id="drawer" swipe-open></app-drawer>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Contributing

If you want to send a PR to this element, here are the instructions for running the tests and demo locally:

Installation

git clone https://github.com/PolymerElements/app-layout
cd app-layout
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm

Compatibility

(Loading compatibility data...)

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

  • @polymer/iron-flex-layout#^3.0.0-pre.26
  • @polymer/iron-media-query#^3.0.0-pre.26
  • @polymer/iron-resizable-behavior#^3.0.0-pre.26
  • @polymer/iron-scroll-target-behavior#^3.0.0-pre.26
  • @polymer/polymer#^3.0.0
Released
2018-11-27
Maturity
IMPORTED
License
BSD 3-clause "New" or "Revised" License

Compatibility

Framework
Polymer 1.0+
Polymer 3.0+
Polymer 2.0+ in 2.1.1
Browser
Browser Independent

app-layout - Vaadin Add-on Directory

App layout elements app-layout - Vaadin Add-on Directory
[![Published on NPM](https://img.shields.io/npm/v/@polymer/app-layout.svg)](https://www.npmjs.com/package/@polymer/app-layout) [![Build status](https://travis-ci.org/PolymerElements/app-layout.svg?branch=master)](https://travis-ci.org/PolymerElements/app-layout) [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/app-layout) ## App Layout A collection of elements, along with guidelines and templates that can be used to structure your app’s layout. ## What is inside ### Elements - [app-box](https://github.com/PolymerElements/app-layout/tree/master/app-box) - A container element that can have scroll effects - visual effects based on scroll position. - [app-drawer](https://github.com/PolymerElements/app-layout/tree/master/app-drawer) - A navigation drawer that can slide in from the left or right. - [app-drawer-layout](https://github.com/PolymerElements/app-layout/tree/master/app-drawer-layout) - A wrapper element that positions an app-drawer and other content. - [app-grid](https://github.com/PolymerElements/app-layout/tree/master/app-grid) - A helper class useful for creating responsive, fluid grid layouts using custom properties. - [app-header](https://github.com/PolymerElements/app-layout/tree/master/app-header) - A container element for app-toolbars at the top of the screen that can have scroll effects - visual effects based on scroll position. - [app-header-layout](https://github.com/PolymerElements/app-layout/tree/master/app-header-layout) - A wrapper element that positions an app-header and other content. - [app-toolbar](https://github.com/PolymerElements/app-layout/tree/master/app-toolbar) - A horizontal toolbar containing items that can be used for label, navigation, search and actions. ### Templates The templates are a means to define, illustrate and share best practices in App Layout. Pick a template and customize it: - **Getting started** ([Demo](https://polymerelements.github.io/app-layout/templates/getting-started) - [Source](/templates/getting-started)) - **Landing page** ([Demo](https://polymerelements.github.io/app-layout/templates/landing-page) - [Source](/templates/landing-page)) - **Publishing: Zuperkülblog** ([Demo](https://polymerelements.github.io/app-layout/templates/publishing) - [Source](/templates/publishing)) - **Shop: Shrine** ([Demo](https://polymerelements.github.io/app-layout/templates/shrine) - [Source](/templates/shrine)) - **Blog: Pesto** ([Demo](https://polymerelements.github.io/app-layout/templates/pesto) - [Source](/templates/pesto)) - **Scroll effects: Test drive** ([Demo](https://polymerelements.github.io/app-layout/templates/test-drive) - [Source](/templates/test-drive)) ### Patterns Sample code for various UI patterns: - **Transform navigation:** As more screen space is available, side navigation can transform into tabs. ([Demo](https://www.webcomponents.org/element/PolymerElements/app-layout/demo/patterns/transform-navigation/index.html) - [Source](/patterns/transform-navigation/x-app.html)) - **Expand Card:** Content cards may expand to take up more horizontal space. ([Demo](https://www.webcomponents.org/element/PolymerElements/app-layout/demo/patterns/expand-card/index.html) - [Source](/patterns/expand-card/index.html)) - **Material Design Responsive Toolbar:** Toolbar changes its height and padding to adapt mobile screen size. ([Demo](https://www.webcomponents.org/element/PolymerElements/app-layout/demo/patterns/md-responsive-toolbar/index.html) - [Source](/patterns/md-responsive-toolbar/index.html)) ## Users Here are some web apps built with App Layout: - [Youtube Web](https://www.youtube.com/new) - [Google I/O 2016](https://events.google.com/io2016/) - [Polymer project site](https://www.polymer-project.org/summit) - [Polymer summit](https://www.polymer-project.org/summit) - [Shop](https://shop.polymer-project.org) - [News](https://news.polymer-project.org) - [webcomponents.org](https://www.webcomponents.org/) - [Chrome Status](https://www.chromestatus.com/) - [Project Fi](https://fi.google.com/about/) - [NASA Open Source Software](https://code.nasa.gov/) See: [Documentation](https://www.webcomponents.org/element/@polymer/app-layout), [Demo](https://www.webcomponents.org/element/@polymer/app-layout/demo/demo/index.html). ## Usage ### Installation ``` npm install --save @polymer/app-layout ``` ### In an html file ```html
My app
``` ### In a Polymer 3 element ```js import {PolymerElement, html} from '@polymer/polymer'; import '@polymer/app-layout/app-layout.js'; class SampleElement extends PolymerElement { static get template() { return html`
My app
`; } } customElements.define('sample-element', SampleElement); ``` ## Contributing If you want to send a PR to this element, here are the instructions for running the tests and demo locally: ### Installation ```sh git clone https://github.com/PolymerElements/app-layout cd app-layout npm install npm install -g polymer-cli ``` ### Running the demo locally ```sh polymer serve --npm open http://127.0.0.1:/demo/ ``` ### Running the tests ```sh polymer test --npm ```
Online