A collapsible sidebar layout.

[ This description is mirrored from README.md at github.com/arsnebula/nebula-sidebar-layout on 2019-05-22 ]

Published on webcomponents.org Polymer Version Sauce Labs Build Status Gitter Chat Become a Patreon

<nebula-sidebar-layout>

A responsive sidebar layout with animated drawer.

  • Two-column application layout using slots
  • Fixed sidebar container on the left, fluid content container on the right
  • Sidebar collapses to an animated slide-out drawer at a specified breakpoint

Installation

$ bower install -S arsnebula/nebula-sidebar-layout

Getting Started

Import the element:

<link rel="import" href="/bower_components/nebula-sidebar-layout/nebula-sidebar-layout.html"> 

The element utilizes offscreen positioning for the drawer when collapsed, so the body and and other parent elements should be set to fill the browser screen. The following is a sample stylesheet for ensuring the body matches the viewport.

<head>
  <style>
    html, body {
      position: relative;
      border: 0;
      margin: 0;
      padding: 0;
      min-height: 100vh;
      width: 100%;
      height: 100%;
      overflow: hidden;
      overflow-y: auto;
      box-sizing: border-box;
    }
  </style>
</head>

Add the element.

<nebula-sidebar-layout
  breakpoint="(max-width: 960px)"
  collapsed="{{collapsed}}"
  opened="{{opened}}"
  on-changed="_onChanged">

  <div slot="sidebar"></div>
  <div slot="content"></div>
</nebula-sidebar-layout>

Style the element.

nebula-sidebar-layout {
  --nebula-sidebar-layout-backdrop-color: hsla(0, 0%, 0%, 0.6);
  --nebula-sidebar-layout-animation-duration: 250ms;
}

For more information, see the API documentation.

Contributing

We welcome and appreciate feedback from the community. Here are a few ways that you can show your appreciation for this package:

  • Give us a Star on GitHub from either webcomponents.org or directly on GitHub.

  • Submit a feature request, or a defect report on the Issues List.

  • Become a Patreon. It takes a lot of time and effort to develop, document, test and support the elements in our Nebula Essentials collection. Your financial contribution will help ensure that our entire collection continues to grow and improve.

If you are a developer, and are interested in making a code contribution, consider opening an issue first to describe the change, and discuss with the core repository maintainers. Once you are ready, prepare a pull request:

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Change Log

See CHANGELOG

License

See LICENSE

Install

Link to this version
ImportedReleased 23 May 2017ISC License
Framework Support
Polymer 2.0+
Also supported:
Polymer 1 (2.0.0)
Browser Compatibility
Install with
bower install --save arsnebula/nebula-sidebar-layout"#2.0.2"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.0.2

Dependencies

  • polymer#Polymer/polymer#^2.0.0
  • nebula-element-mixin#arsnebula/nebula-element-mixin#^2.0.0
  • nebula-media-query#arsnebula/nebula-media-query#^2.0.0