OLD | NEW |
1 | 1 |
2 <!--- | 2 <!--- |
3 | 3 |
4 This README is automatically generated from the comments in these files: | 4 This README is automatically generated from the comments in these files: |
5 iron-overlay-backdrop.html iron-overlay-behavior.html | 5 iron-overlay-backdrop.html iron-overlay-behavior.html |
6 | 6 |
7 Edit those files, and our readme bot will duplicate them over here! | 7 Edit those files, and our readme bot will duplicate them over here! |
8 Edit this file, and the bot will squash your changes :) | 8 Edit this file, and the bot will squash your changes :) |
9 | 9 |
10 The bot does some handling of markdown. Please file a bug if it does the wrong | 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 | 11 thing! https://github.com/PolymerLabs/tedium/issues |
12 | 12 |
13 --> | 13 --> |
14 | 14 |
15 [![Build status](https://travis-ci.org/PolymerElements/iron-overlay-behavior.svg
?branch=master)](https://travis-ci.org/PolymerElements/iron-overlay-behavior) | 15 [![Build status](https://travis-ci.org/PolymerElements/iron-overlay-behavior.svg
?branch=master)](https://travis-ci.org/PolymerElements/iron-overlay-behavior) |
16 | 16 |
17 _[Demo and API docs](https://elements.polymer-project.org/elements/iron-overlay-
behavior)_ | 17 _[Demo and API docs](https://elements.polymer-project.org/elements/iron-overlay-
behavior)_ |
18 | 18 |
19 | 19 |
20 ##<iron-overlay-backdrop> | |
21 | |
22 `iron-overlay-backdrop` is a backdrop used by `Polymer.IronOverlayBehavior`. It
should be a | |
23 singleton. | |
24 | |
25 ### Styling | |
26 | |
27 The following custom properties and mixins are available for styling. | |
28 | |
29 | Custom property | Description | Default | | |
30 | --- | --- | --- | | |
31 | `--iron-overlay-backdrop-background-color` | Backdrop background color | #000
| | |
32 | `--iron-overlay-backdrop-opacity` | Backdrop opacity | 0.6 | | |
33 | `--iron-overlay-backdrop` | Mixin applied to `iron-overlay-backdrop`. | {} | | |
34 | `--iron-overlay-backdrop-opened` | Mixin applied to `iron-overlay-backdrop` wh
en it is displayed | {} | | |
35 | |
36 | |
37 | |
38 ##Polymer.IronOverlayBehavior | 20 ##Polymer.IronOverlayBehavior |
39 | 21 |
40 Use `Polymer.IronOverlayBehavior` to implement an element that can be hidden or
shown, and displays | 22 Use `Polymer.IronOverlayBehavior` to implement an element that can be hidden or
shown, and displays |
41 on top of other content. It includes an optional backdrop, and can be used to im
plement a variety | 23 on top of other content. It includes an optional backdrop, and can be used to im
plement a variety |
42 of UI controls including dialogs and drop downs. Multiple overlays may be displa
yed at once. | 24 of UI controls including dialogs and drop downs. Multiple overlays may be displa
yed at once. |
43 | 25 |
44 ### Closing and canceling | 26 ### Closing and canceling |
45 | 27 |
46 A dialog may be hidden by closing or canceling. The difference between close and
cancel is user | 28 A dialog may be hidden by closing or canceling. The difference between close and
cancel is user |
47 intent. Closing generally implies that the user acknowledged the content on the
overlay. By default, | 29 intent. Closing generally implies that the user acknowledged the content on the
overlay. By default, |
(...skipping 14 matching lines...) Expand all Loading... |
62 appended to `<body>` and is of type `<iron-overlay-backdrop>`. See its doc page
for styling | 44 appended to `<body>` and is of type `<iron-overlay-backdrop>`. See its doc page
for styling |
63 options. | 45 options. |
64 | 46 |
65 ### Limitations | 47 ### Limitations |
66 | 48 |
67 The element is styled to appear on top of other content by setting its `z-index`
property. You | 49 The element is styled to appear on top of other content by setting its `z-index`
property. You |
68 must ensure no element has a stacking context with a higher `z-index` than its p
arent stacking | 50 must ensure no element has a stacking context with a higher `z-index` than its p
arent stacking |
69 context. You should place this element as a child of `<body>` whenever possible. | 51 context. You should place this element as a child of `<body>` whenever possible. |
70 | 52 |
71 | 53 |
| 54 |
| 55 ##<iron-overlay-backdrop> |
| 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` wh
en it is displayed | {} | |
| 70 |
| 71 |
OLD | NEW |