OLD | NEW |
1 // DO NOT EDIT: auto-generated with `pub run custom_element_apigen:update` | 1 // DO NOT EDIT: auto-generated with `pub run custom_element_apigen:update` |
2 | 2 |
3 /// Dart API for the polymer element `iron_overlay_behavior`. | 3 /// Dart API for the polymer element `iron_overlay_behavior`. |
4 @HtmlImport('iron_overlay_behavior_nodart.html') | 4 @HtmlImport('iron_overlay_behavior_nodart.html') |
5 library polymer_elements.lib.src.iron_overlay_behavior.iron_overlay_behavior; | 5 library polymer_elements.lib.src.iron_overlay_behavior.iron_overlay_behavior; |
6 | 6 |
7 import 'dart:html'; | 7 import 'dart:html'; |
8 import 'dart:js' show JsArray, JsObject; | 8 import 'dart:js' show JsArray, JsObject; |
9 import 'package:web_components/web_components.dart'; | 9 import 'package:web_components/web_components.dart'; |
10 import 'package:polymer_interop/polymer_interop.dart'; | 10 import 'package:polymer_interop/polymer_interop.dart'; |
11 import 'iron_fit_behavior.dart'; | 11 import 'iron_fit_behavior.dart'; |
12 import 'iron_resizable_behavior.dart'; | 12 import 'iron_resizable_behavior.dart'; |
13 import 'iron_overlay_backdrop.dart'; | 13 import 'iron_overlay_backdrop.dart'; |
14 | 14 |
15 /// Use `Polymer.IronOverlayBehavior` to implement an element that can be hidden
or shown, and displays | 15 /// Use `Polymer.IronOverlayBehavior` to implement an element that can be hidden
or shown, and displays |
16 /// on top of other content. It includes an optional backdrop, and can be used t
o implement a variety | 16 /// on top of other content. It includes an optional backdrop, and can be used t
o implement a variety |
17 /// of UI controls including dialogs and drop downs. Multiple overlays may be di
splayed at once. | 17 /// of UI controls including dialogs and drop downs. Multiple overlays may be di
splayed at once. |
18 /// | 18 /// |
19 /// ### Closing and canceling | 19 /// ### Closing and canceling |
20 /// | 20 /// |
21 /// A dialog may be hidden by closing or canceling. The difference between close
and cancel is user | 21 /// A dialog may be hidden by closing or canceling. The difference between close
and cancel is user |
22 /// intent. Closing generally implies that the user acknowledged the content on
the overlay. By default, | 22 /// intent. Closing generally implies that the user acknowledged the content on
the overlay. By default, |
23 /// it will cancel whenever the user taps outside it or presses the escape key.
This behavior is | 23 /// it will cancel whenever the user taps outside it or presses the escape key.
This behavior is |
24 /// configurable with the `no-cancel-on-esc-key` and the `no-cancel-on-outside-c
lick` properties. | 24 /// configurable with the `no-cancel-on-esc-key` and the `no-cancel-on-outside-c
lick` properties. |
25 /// `close()` should be called explicitly by the implementer when the user inter
acts with a control | 25 /// `close()` should be called explicitly by the implementer when the user inter
acts with a control |
26 /// in the overlay element. | 26 /// in the overlay element. When the dialog is canceled, the overlay fires an 'i
ron-overlay-canceled' |
| 27 /// event. Call `preventDefault` on this event to prevent the overlay from closi
ng. |
27 /// | 28 /// |
28 /// ### Positioning | 29 /// ### Positioning |
29 /// | 30 /// |
30 /// By default the element is sized and positioned to fit and centered inside th
e window. You can | 31 /// By default the element is sized and positioned to fit and centered inside th
e window. You can |
31 /// position and size it manually using CSS. See `Polymer.IronFitBehavior`. | 32 /// position and size it manually using CSS. See `Polymer.IronFitBehavior`. |
32 /// | 33 /// |
33 /// ### Backdrop | 34 /// ### Backdrop |
34 /// | 35 /// |
35 /// Set the `with-backdrop` attribute to display a backdrop behind the overlay.
The backdrop is | 36 /// Set the `with-backdrop` attribute to display a backdrop behind the overlay.
The backdrop is |
36 /// appended to `<body>` and is of type `<iron-overlay-backdrop>`. See its doc p
age for styling | 37 /// appended to `<body>` and is of type `<iron-overlay-backdrop>`. See its doc p
age for styling |
(...skipping 51 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
88 open() => | 89 open() => |
89 jsElement.callMethod('open', []); | 90 jsElement.callMethod('open', []); |
90 | 91 |
91 /// Toggle the opened state of the overlay. | 92 /// Toggle the opened state of the overlay. |
92 toggle() => | 93 toggle() => |
93 jsElement.callMethod('toggle', []); | 94 jsElement.callMethod('toggle', []); |
94 | 95 |
95 registered() => | 96 registered() => |
96 jsElement.callMethod('registered', []); | 97 jsElement.callMethod('registered', []); |
97 } | 98 } |
OLD | NEW |