docs(readme): add info about @@attached action type

tusharmath · Sep 3, 2016 · ec2d201 · ec2d201
1 parent 60dc2b0
commit ec2d201
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -177,12 +177,24 @@ update (state, {type, params}) {
   switch (type) {
     case '@@attr/some-custom-attribute':
       return {count: state.count + parseInt(params)}
-    case default: return state
+    default: return state
   }
 }
 ```
 
+## Listening to the attached event
+A special action `@@attached` is fired when the component is attached into the DOM. 
+The `param` for this action is the instance of the web component.
 
+```js
+update (state, {type, params}) {
+  switch (type) {
+    case '@@attached':
+      return {width: params.getBoundingClientRect().width}
+    default: return state
+  }
+}
+```
 
 
 <a name="module_raf"></a>

diff --git a/docs/README.template.md b/docs/README.template.md
@@ -177,12 +177,24 @@ update (state, {type, params}) {
   switch (type) {
     case '@@attr/some-custom-attribute':
       return {count: state.count + parseInt(params)}
-    case default: return state
+    default: return state
   }
 }
 ```
 
+## Listening to the attached event
+A special action `@@attached` is fired when the component is attached into the DOM. 
+The `param` for this action is the instance of the web component.
 
+```js
+update (state, {type, params}) {
+  switch (type) {
+    case '@@attached':
+      return {width: params.getBoundingClientRect().width}
+    default: return state
+  }
+}
+```
 
 
 {{>main}}