fixes documentation and enhances the inline demo

vpusher · Nov 13, 2016 · e132cb9 · e132cb9
1 parent 153e146
commit e132cb9
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,8 @@ Example:
 <custom-element-demo>
   <template>
     <script src="../webcomponentsjs/webcomponents-lite.js"></script>
+    <link rel="import" href="../iron-icons/notification-icons.html">
+    <link rel="import" href="../iron-icons/av-icons.html">
     <link rel="import" href="paper-tree.html">
     <next-code-block></next-code-block>
   </template>
@@ -20,35 +22,37 @@ Example:
 -->
 ```html
 <paper-tree data='{
-    "name": "GOT",
-    "icon": "theaters",
+    "name": "Media Center",
+    "icon": "weekend",
     "open": true,
     "children": [{
-        "name": "Starks",
-        "icon": "turned-in",
+        "name": "Movies",
+        "icon": "av:movie",
         "children": [{
-            "icon": "account-circle",
-            "name": "Eddard"
+            "name": "Interstellar",
+            "icon": "theaters"
         }, {
-            "name": "Catelyn",
-            "icon": "account-circle"
+            "name": "The Godfather",
+            "icon": "theaters"
         }, {
-            "name": "Sansa",
-            "icon": "account-circle"
-        }, {
-            "name": "Robb",
-            "icon": "account-circle"
-        }, {
-            "name": "Bran",
-            "icon": "account-circle"
-        }, {
-            "name": "Arya",
-            "icon": "account-circle"
+            "name": "Pulp Fiction",
+            "icon": "theaters"
+        }]
+    }, {
+        "name": "TV Shows",
+        "icon": "notification:live-tv",
+        "children": [{
+            "name": "Breaking Bad",
+            "icon": "theaters"
         }, {
-            "name": "Rickson",
-            "icon": "account-circle"
+            "name": "Game of Thrones",
+            "icon": "theaters"
         }]
-    }]}'>
+    }]}'
+    actions='[{
+        "label": "Play",
+        "event": "play"
+    }]'>
  </paper-tree>
 ```
 
@@ -83,7 +87,7 @@ See documentation to know the options and structure of the `data` attribute.
 
 ## History
 
-* **1.0:** initial release.
+* **1.0.0:** initial release.
 
 ## License
 

diff --git a/paper-tree-node.html b/paper-tree-node.html
@@ -154,7 +154,11 @@
             },
 
             /**
-             * Actions available this node.
+             * `actions` available for this node. Each action object has the following fields:
+             *
+             * - `action.label`: string representing the display name of the menu item.
+             * - `action.event`: string which is the event name to dispatch whenever the item is clicked.
+             *
              */
             actions: {
                 type: Array,

diff --git a/paper-tree.html b/paper-tree.html
@@ -59,10 +59,10 @@
             },
 
             /**
-             * `actions` available for all nodes.
+             * `actions` available for all nodes. Each action object has the following fields:
              *
              * - `action.label`: string representing the display name of the menu item.
-             * - `data.event`: string which is the event name to dispatch whenever the item is clicked.
+             * - `action.event`: string which is the event name to dispatch whenever the item is clicked.
              *
              */
             actions: {