Home | History | Annotate | only in /external/chromium-trace/catapult/third_party/polymer/components/iron-overlay-behavior
Up to higher level directory
NameDateSize
.bower.json06-Dec-20161.6K
.github/06-Dec-2016
.gitignore06-Dec-201617
.travis.yml06-Dec-2016789
bower.json06-Dec-20161.2K
CONTRIBUTING.md06-Dec-20163.4K
demo/06-Dec-2016
index.html06-Dec-2016999
iron-overlay-backdrop.html06-Dec-20164.3K
iron-overlay-behavior.html06-Dec-201619.5K
iron-overlay-manager.html06-Dec-201611.7K
README.md06-Dec-20162.9K
test/06-Dec-2016

README.md

      1 
      2 <!---
      3 
      4 This README is automatically generated from the comments in these files:
      5 iron-overlay-backdrop.html  iron-overlay-behavior.html
      6 
      7 Edit those files, and our readme bot will duplicate them over here!
      8 Edit this file, and the bot will squash your changes :)
      9 
     10 The bot does some handling of markdown. Please file a bug if it does the wrong
     11 thing! https://github.com/PolymerLabs/tedium/issues
     12 
     13 -->
     14 
     15 [![Build status](https://travis-ci.org/PolymerElements/iron-overlay-behavior.svg?branch=master)](https://travis-ci.org/PolymerElements/iron-overlay-behavior)
     16 
     17 _[Demo and API docs](https://elements.polymer-project.org/elements/iron-overlay-behavior)_
     18 
     19 
     20 ##Polymer.IronOverlayBehavior
     21 
     22 Use `Polymer.IronOverlayBehavior` to implement an element that can be hidden or shown, and displays
     23 on top of other content. It includes an optional backdrop, and can be used to implement a variety
     24 of UI controls including dialogs and drop downs. Multiple overlays may be displayed at once.
     25 
     26 ### Closing and canceling
     27 
     28 A dialog may be hidden by closing or canceling. The difference between close and cancel is user
     29 intent. Closing generally implies that the user acknowledged the content on the overlay. By default,
     30 it will cancel whenever the user taps outside it or presses the escape key. This behavior is
     31 configurable with the `no-cancel-on-esc-key` and the `no-cancel-on-outside-click` properties.
     32 `close()` should be called explicitly by the implementer when the user interacts with a control
     33 in the overlay element. When the dialog is canceled, the overlay fires an 'iron-overlay-canceled'
     34 event. Call `preventDefault` on this event to prevent the overlay from closing.
     35 
     36 ### Positioning
     37 
     38 By default the element is sized and positioned to fit and centered inside the window. You can
     39 position and size it manually using CSS. See `Polymer.IronFitBehavior`.
     40 
     41 ### Backdrop
     42 
     43 Set the `with-backdrop` attribute to display a backdrop behind the overlay. The backdrop is
     44 appended to `<body>` and is of type `<iron-overlay-backdrop>`. See its doc page for styling
     45 options.
     46 
     47 ### Limitations
     48 
     49 The element is styled to appear on top of other content by setting its `z-index` property. You
     50 must ensure no element has a stacking context with a higher `z-index` than its parent stacking
     51 context. You should place this element as a child of `<body>` whenever possible.
     52 
     53 
     54 
     55 ##&lt;iron-overlay-backdrop&gt;
     56 
     57 `iron-overlay-backdrop` is a backdrop used by `Polymer.IronOverlayBehavior`. It should be a
     58 singleton.
     59 
     60 ### Styling
     61 
     62 The following custom properties and mixins are available for styling.
     63 
     64 | Custom property | Description | Default |
     65 | --- | --- | --- |
     66 | `--iron-overlay-backdrop-background-color` | Backdrop background color | #000 |
     67 | `--iron-overlay-backdrop-opacity` | Backdrop opacity | 0.6 |
     68 | `--iron-overlay-backdrop` | Mixin applied to `iron-overlay-backdrop`. | {} |
     69 | `--iron-overlay-backdrop-opened` | Mixin applied to `iron-overlay-backdrop` when it is displayed | {} |
     70 
     71 
     72