3.1.0 • Published 5 years ago

@polymer/app-layout v3.1.0

Weekly downloads
9,082
License
BSD-3-Clause
Repository
github
Last release
5 years ago

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
zagenzagen-productionplaytwo-core-cms-sections@navigateconsulting/eva-botzagen-zagen@teipublisher/pb-components7@infinitebrahmanuniverse/nolb-_pol@everything-registry/sub-chunk-731@boluabraham/fhir-navbar@lucentray/pine-web-components@navigateconsulting/web-channelmumaa-dialogmicro-fabric-ux@flowingcode/fc-applayout@feezal/feezal-element-app-layout@feezal/feezal-element-paper-app-layout@juanbeato/jb-layoutoe-studio@iconica/iconicaelementsnodecg@spriteful/spriteful-app-shell@spriteful/spriteful-header-overlay@spriteful/app-header-overlay@spriteful/app-shell@teipublisher/pb-components@rwestlund/responsive-dialog@rammbulanz/lit-app-layoutsdl-hello-vue@silverlinkz/sl-gallery@sibley/myuw-app-bar@shifang2013/log-in@sdl-web/sdl-hello-vue@smyd/app-shell@smyd/app-overlayspolymer-starter-kitpolymer-starter-kit-publish-demo@l9/layout@l9/page@things-real/shell@things-shell/board-modeller@things-shell/real-modellerfhir-navbar@longlost/app-header-overlay@longlost/app-overlays@nuskin/ns-app-elements@nuskin/ns-dev-portal@lrnwebcomponents/contenta-polymer@longlost/app-shell@lrnwebcomponents/haxcms-elements@lrnwebcomponents/haxor-slevin@lrnwebcomponents/learn-two-theme@lrnwebcomponents/eco-json-schema-form@lrnwebcomponents/game-show-quiz@lrnwebcomponents/outline-player@lrnwebcomponents/lrndesign-contentsequencer@lrnwebcomponents/lrndesign-drawer@lrnwebcomponents/lrnapp-book@lrnwebcomponents/lrnsys-comment@lrnwebcomponents/lrnsys-layout@lrnwebcomponents/pdf-element@lrnwebcomponents/per-spec-tive@lrnwebcomponents/simple-drawer@lrnwebcomponents/paper-search@moduware/morph-sidebar@polymer/app-elements@polymer/polymer-starter-kit@polymer/iron-component-pagepwa-shell@wonkytech/wired-elementsglobular-mvc@advanced-rest-client/arc-app-mixin@anviltech/wuf-poly-paper-elementshomeassistant-frontend-raceland@vowo/vowo-submenu-dialogvowo-submenu-dialogunity-core-betaallianz-chartsapi-console@anypoint-web-components/api-consoleboo-color-selector@dorgtech/daosmind@cwmr/paper-search@hatiolab/things-shell@heyokaysaturday/test-components@hydrofoil/hydrofoil-paper-shell
3.1.0

5 years ago

3.0.2

5 years ago

3.0.1

6 years ago

3.0.0

6 years ago

3.0.0-pre.26

6 years ago

3.0.0-pre.25

6 years ago

3.0.0-pre.24

6 years ago

3.0.0-pre.23

6 years ago

3.0.0-pre.22

6 years ago

3.0.0-pre.21

6 years ago

3.0.0-pre.20

6 years ago

3.0.0-pre.19

6 years ago

3.0.0-pre.18

6 years ago

3.0.0-pre.17

6 years ago

3.0.0-pre.16

6 years ago

3.0.0-pre.15

6 years ago

3.0.0-pre.14

6 years ago

3.0.0-pre.13

6 years ago

3.0.0-pre.12

6 years ago

3.0.0-pre.11

6 years ago

3.0.0-pre.10

6 years ago

3.0.0-pre.8

6 years ago

3.0.0-pre.7

6 years ago

3.0.0-pre.6

6 years ago

3.0.0-pre.4

6 years ago

3.0.0-pre.3

6 years ago

3.0.0-pre.2

6 years ago

3.0.0-pre.1

7 years ago

0.10.6-pre.3

7 years ago

0.10.6-pre.2

7 years ago

0.10.6-pre.1

7 years ago