docs: update dispatch options parameter

hybridsjs · Apr 3, 2019 · 9c6b60e · 9c6b60e
1 parent 993c52b
commit 9c6b60e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/docs/misc/api-reference.md b/docs/misc/api-reference.md
@@ -167,6 +167,10 @@ dispatch(host: Element, eventType: string, options): Boolean
 * **arguments**:
   * `host` - element instance
   * `eventType` - type of the event to be dispatched
-  * `options` - object following `dispatchEvent` DOM API specification
+  * `options` - a dictionary, having the following optional fields:
+    * `bubbles`: a boolean indicating whether the event bubbles. The default is false
+    * `cancelable`: a boolean indicating whether the event can be cancelled. The default is false
+    * `composed`: a boolean indicating whether the event will trigger listeners outside of a shadow root The default is false
+    * `detail`: a custom data, which will be passed to an event listener
 * **returns**:
   * `false` if event is cancelable and at least one of the event handlers which handled this event called `preventDefault()`, otherwise it returns `true`
diff --git a/docs/misc/utils.md b/docs/misc/utils.md
@@ -1,15 +1,19 @@
 # Utils
 
-## Dispatching Events
+## Event Dispatcher
 
 ```typescript
-dispatch(host: Element, eventType: string, options): Boolean
+dispatch(host: Element, eventType: string, [options]): Boolean
 ```
 
 * **arguments**:
   * `host` - element instance
   * `eventType` - type of the event to be dispatched
-  * `options` - object following `dispatchEvent` DOM API specification
+  * `options` - a dictionary, having the following optional fields:
+    * `bubbles`: a boolean indicating whether the event bubbles. The default is false
+    * `cancelable`: a boolean indicating whether the event can be cancelled. The default is false
+    * `composed`: a boolean indicating whether the event will trigger listeners outside of a shadow root The default is false
+    * `detail`: a custom data, which will be passed to an event listener
 * **returns**:
   * `false` if event is cancelable and at least one of the event handlers which handled this event called `preventDefault()`, otherwise it returns `true`
 
@@ -24,7 +28,7 @@ import { html, dispatch } from 'hybrids';
 function change(host) {
   host.value += 1;
   // Trigger not bubbling `change` custom event
-  dispatch(host, 'change');
+  dispatch(host, 'change', { detail: host.value });
 }
 
 const MyElement = {