docs(readme): add infor about dispatching @rwc/event/*

tusharmath · Sep 8, 2016 · eec77cd · eec77cd
1 parent 578cc7f
commit eec77cd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -190,6 +190,7 @@ export const update = (state, {type, params}) => {
 - `@@rwc/created`: Fired when the web component is initialized. The `params` for this action is the instance of the web component.
 - `@@rwc/attached`: Dispatched when the web component is inserted into the DOM. This is a good time to call something like `params.getBoundingClientRect()` to get the dimensions of the web component and keep it in the state.
 - `@@rwc/detached`: Dispatched when the component is removed from the DOM.
+- `@@rwc/event/<event name>`: Whenever an [Event] type is returned from the `update` function, this action is automatically fired.
 - `@@rwc/attr/<attr name>`: This is fired whenever a web component's attribute is changed. The `param` is the current value of the attribute.
 - `@@rwc/prop/<prop name>`: Attributes have a limitation of passing data that is of `string` type only. For this purpose you can predefine some `props` that `rwc` will attach hooks on and whenever they are changed, this particular action will be fired.
   ```js

diff --git a/docs/README.template.md b/docs/README.template.md
@@ -190,6 +190,7 @@ export const update = (state, {type, params}) => {
 - `@@rwc/created`: Fired when the web component is initialized. The `params` for this action is the instance of the web component.
 - `@@rwc/attached`: Dispatched when the web component is inserted into the DOM. This is a good time to call something like `params.getBoundingClientRect()` to get the dimensions of the web component and keep it in the state.
 - `@@rwc/detached`: Dispatched when the component is removed from the DOM.
+- `@@rwc/event/<event name>`: Whenever an [Event] type is returned from the `update` function, this action is automatically fired.
 - `@@rwc/attr/<attr name>`: This is fired whenever a web component's attribute is changed. The `param` is the current value of the attribute.
 - `@@rwc/prop/<prop name>`: Attributes have a limitation of passing data that is of `string` type only. For this purpose you can predefine some `props` that `rwc` will attach hooks on and whenever they are changed, this particular action will be fired.
   ```js