Skip to content
This repository has been archived by the owner on Dec 19, 2024. It is now read-only.

Commit

Permalink
link to simple-overlay example (#190)
Browse files Browse the repository at this point in the history
* link to simple-overlay example

* explain limitation of focus wrapping
  • Loading branch information
valdrinkoshi authored Jun 27, 2016
1 parent dde758a commit 0b8da8d
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions iron-overlay-behavior.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,12 @@
on top of other content. It includes an optional backdrop, and can be used to implement a variety
of UI controls including dialogs and drop downs. Multiple overlays may be displayed at once.
See the [demo source code](https://github.com/PolymerElements/iron-overlay-behavior/blob/master/demo/simple-overlay.html)
for an example.
### Closing and canceling
A dialog may be hidden by closing or canceling. The difference between close and cancel is user
An overlay may be hidden by closing or canceling. The difference between close and cancel is user
intent. Closing generally implies that the user acknowledged the content on the overlay. By default,
it will cancel whenever the user taps outside it or presses the escape key. This behavior is
configurable with the `no-cancel-on-esc-key` and the `no-cancel-on-outside-click` properties.
Expand All @@ -43,6 +46,10 @@
appended to `<body>` and is of type `<iron-overlay-backdrop>`. See its doc page for styling
options.
In addition, `with-backdrop` will wrap the focus within the content in the light DOM.
Override the [`_focusableNodes` getter](#Polymer.IronOverlayBehavior:property-_focusableNodes)
to achieve a different behavior.
### Limitations
The element is styled to appear on top of other content by setting its `z-index` property. You
Expand Down Expand Up @@ -78,7 +85,8 @@
},

/**
* Set to true to display a backdrop behind the overlay.
* Set to true to display a backdrop behind the overlay. It traps the focus
* within the light DOM of the overlay.
*/
withBackdrop: {
observer: '_withBackdropChanged',
Expand Down

0 comments on commit 0b8da8d

Please sign in to comment.