third_party/polymer/v1_0/components-chromium/iron-overlay-behavior/README.md

   1 # iron-overlay-behavior
   2 Makes an element an overlay with an optional backdrop.
   3
   4 `iron-overlay-behavior` displays an element on top of other content. It starts out hidden and is
   5 displayed by calling `open()` or setting the `opened` property to `true`. It may be closed by
   6 calling `close()` or `cancel()`, or by setting the `opened` property to `false`.
   7
   8 The difference between `close()` and `cancel()` is user intent. `close()` generally implies that
   9 the user acknowledged the content of the overlay. By default, it will cancel whenever the user taps
  10 outside it or presses the escape key. This behavior can be turned off via the `no-cancel-on-esc-key`
  11 and the `no-cancel-on-outside-click` properties.