Skip to content

Commit 7c3e516

Browse files
committed
Clarify fire option defaults. Fixes #2180
1 parent 9bdcc3b commit 7c3e516

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

‎src/standard/utils.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,10 @@
148148
* @param {String} type Name of event type.
149149
* @param {Object=} detail Detail object containing event-specific
150150
* payload.
151-
* @param {Object=} options Object specifying options. These
152-
* may include `bubbles` (boolean), `cancelable` (boolean), and `node`
153-
* on which to fire the event (HTMLElement, defaults to `this`).
151+
* @param {Object=} options Object specifying options. These may include:
152+
* `bubbles` (boolean, defaults to `true`),
153+
* `cancelable` (boolean, defaults to false), and
154+
* `node` on which to fire the event (HTMLElement, defaults to `this`).
154155
* @return {CustomEvent} The new event that was fired.
155156
*/
156157
fire: function(type, detail, options) {

0 commit comments

Comments
 (0)