Merge pull request #8 from FuzzicalLogic/master

FuzzicalLogic · web-flow · commit b1e391198a07 · 2019-02-08T05:32:22.000-07:00
Documentation
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ targets when that event is handled.
 
 Invoke the `remote` method on the parent element every time a `trigger` event is received by the `window`.
 ```html
-<fluid-triggered-method handle="trigger" call="remote">
+<fluid-triggered-method handle="trigger" method="remote">
 </fluid-triggered-method>
 ```
 
@@ -51,34 +51,140 @@ Invoke the `remote` method on the parent element every time a `trigger` event is
 
 ### `handle` attribute
 
+`String<EventName>`
+
+The event that the proxy handler listens for to trigger the method call. Will listen for `'trigger'`, unless specified.
+
+```html
+<fluid-triggered-method handle="my-event">
+</fluid-triggered-method>
+```
+
+### `listens` attribute
+
 `String<CSS Selector>`
 
-Array of element nodes to handle the event on. If omitted, `<fluid-triggered-method>` will listen on the `window` or `global` object.
+Will trigger the method for each element returned by a valid CSS query
+selector. If omitted, `<fluid-triggered-method>` will listen on the `window` or
+`global` object.
 
 ```html
-<fluid-triggered-method handle="">
+<fluid-triggered-method handle="multi-event" listens=".Class">
+</fluid-triggered-method>
+```
+
+### `method` attribute
+
+`String<MethodName>` *Case-Sensitive*
+
+The method to call on the target element(s) when the event is handled. The
+method must be ***publicly accessible*** on the element object, not an internal
+or private API.
+
+```
+<fluid-triggered-method method="callMe">
 </fluid-triggered-method>
 ```
 
 ### `targets` attribute
 
 `String<CSS Selector>`
 
-Array of element nodes to invoke the method on when the event is handled. If omitted, `<fluid-triggered-method>` will invoke the method on its `parentElement` or its `host`.
+Array of element nodes to invoke the method on when the event is handled. If
+omitted, `<fluid-triggered-method>` will invoke the method on it's `host` or
+it's `parentElement`.
 
 ```html
 <fluid-triggered-method targets="">
 </fluid-triggered-method>
 ```
 
+### `cancel` attribute
+
+`Boolean`
+
+Event behaves as if `preventDefault()` has been called on it.
+
+```html
+<fluid-triggered-method handle="cancelme" cancel></fluid-triggered-method>
+```
+
+### `stop` attribute
+
+`Boolean`
+
+Calls `stopPropagation()` on the event when it is handled.
+
+```html
+<fluid-triggered-method handle="happening" stop></fluid-triggered-method>
+```
+
+### `immediate` attribute
+
+`Boolean`
+
+If [`stop` attribute](#stopattribute) is `true`, then when the event is handled, `stopImmediatePropagation()` will be called on it, preventing further bubbling.
+
+```html
+<fluid-triggered-method handle="trigger" stop immediate>
+</fluid-triggered-method>
+```
 ## Imperative API (JS/ES)
 
+### `element.handle`
+
+Returns `String`
+
+The name of the event that `<fluid-triggered-method>` is listening for.
+Changing the event will remove all listeners for the previous event name and
+add new listeners for the new name.
+
+### `element.listensSelector`
+
+Returns `String<CSSSelector>`
+
+Gets or sets the selector on which to listen for the desired event on. Will
+remove listeners and add new listeners when the selector is changed.
+
+### `element.listens`
+
+Returns `Array` - *ReadOnly*
+
+An Array of element nodes that listeners will be added to.
+
+### `element.targetSelector`
+
+Returns `String<CSSSelector>`
+
+Gets or sets the selector on which to invoke the method and forward the event.
+Will remove listeners and add new listeners when the selector is changed.
+
+
 ### `element.targets`
 
 Returns `Array` - *ReadOnly*
 
 An Array of element nodes that the method will be `call`ed on.
 
+### `element.cancel`
+
+Returns `Boolean`
+
+Whether to call `preventDefault()` on the handled event.
+
+
+### `element.stop`
+
+Returns `Boolean`
+
+Whether to call `stopPropagation()` on the handled event.
+
+### `element.immediate`
+
+Returns `Boolean`
+
+Whether to call `stopImmediatePropagation()` on the handled event.
+
 ## DOM Events
 
 `<fluid-triggered-method>` is intended as a method proxy that is triggerd when events are handled. It does not currently dispatch its own events.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cogizmo/fluid-triggered-method",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "description": "Custom Element that invokes an element's method when a specified event is received.",
   "main": "src/component.js",
   "scripts": {
diff --git a/src/package.json b/src/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cogizmo/fluid-triggered-method",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "description": "Custom Element that invokes an element's method when a specified event is received.",
   "main": "component.mjs",
   "scripts": {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@cogizmo/fluid-triggered-method",`
`3`		`- "version": "0.7.3",`
	`3`	`+ "version": "0.7.4",`
`4`	`4`	`"description": "Custom Element that invokes an element's method when a specified event is received.",`
`5`	`5`	`"main": "src/component.js",`
`6`	`6`	`"scripts": {`