From e132cb9eb2f293cb504e83df5cb654993526dac5 Mon Sep 17 00:00:00 2001 From: Florian Maffini Date: Sun, 13 Nov 2016 15:20:46 +0100 Subject: [PATCH] fixes documentation and enhances the inline demo --- README.md | 50 ++++++++++++++++++++++++-------------------- paper-tree-node.html | 6 +++++- paper-tree.html | 4 ++-- 3 files changed, 34 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index db8da49..7c95482 100755 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ Example: @@ -20,35 +22,37 @@ Example: --> ```html + }]}' + actions='[{ + "label": "Play", + "event": "play" + }]'> ``` @@ -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 index 5eaff04..bed43c3 100755 --- 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 index 0fa6898..b3229a0 100755 --- 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: {