Merge pull request #26 from dwickern/improve-docs

Improve docs

Author: dwickern

README.md

@@ -26,6 +26,14 @@ Usage
 
 [View the docs here](https://dwickern.github.io/ember-basic-tree/).
 
+```hbs
+<BasicTree as |tree|>
+  <tree.Node @content="ember" @isExpanded={{true}}>
+    <tree.Node @content="basic"/>
+    <tree.Node @content="tree"/>
+  </tree.Node>
+</BasicTree>
+```
 
 Contributing
 ------------------------------------------------------------------------------

package.json

@@ -62,9 +62,12 @@
     "ember-cli-inject-live-reload": "^2.1.0",
     "ember-cli-sri": "^2.1.1",
     "ember-cli-terser": "^4.0.2",
+    "ember-click-outside": "^2.0.0",
     "ember-concurrency": "^2.2.0",
+    "ember-concurrency-decorators": "^2.0.3",
     "ember-data": "^3.24.0",
     "ember-disable-prototype-extensions": "^1.1.3",
+    "ember-event-helpers": "^0.1.1",
     "ember-export-application-global": "^2.0.1",
     "ember-load-initializers": "^2.1.2",
     "ember-maybe-import-regenerator": "^0.1.6",

tests/dummy/app/components/context-menu-example/content.hbs

@@ -1,11 +1,14 @@
 {{! BEGIN-SNIPPET context-menu-content.hbs }}
 <BasicDropdown as |dd|>
-  <dd.Trigger {{on "contextmenu" (fn this.openContextMenu dd)}}>
+  <dd.Trigger {{on "contextmenu" (prevent-default dd.actions.open)}}>
     {{@node.content}}
   </dd.Trigger>
-  <dd.Content class="context-menu-example--dropdown-content">
+  <dd.Content
+    class="context-menu-example--dropdown-content"
+    {{on-click-outside dd.actions.close eventType="contextmenu"}}
+  >
     {{#if @node.menuComponent}}
-      {{component @node.menuComponent}}
+      <@node.menuComponent/>
     {{else}}
       {{@node.menuText}}
     {{/if}}

tests/dummy/app/components/context-menu-example/content.js

@@ -1,6 +1,7 @@
 // BEGIN-SNIPPET custom-children-js-index.js
 import Component from '@glimmer/component';
-import { task, timeout } from 'ember-concurrency';
+import { task } from 'ember-concurrency-decorators';
+import { timeout } from 'ember-concurrency';
 
 class Node {
   constructor(counter, more) {
@@ -16,16 +17,16 @@ class Node {
 }
 
 export default class extends Component {
-  @task(function* () {
+  @task
+  *loadMore() {
     yield timeout(1000);
 
     const nodes = [];
     for (let i = 0; i < 3; ++i) {
       nodes.push(this.generateNode());
     }
     return nodes;
-  })
-  loadMore;
+  }
 
   counter = 0;
 

tests/dummy/app/components/custom-children-js/index.js

@@ -4,6 +4,5 @@
   </demo.example>
   <demo.snippet @name="context-menu-example.hbs"/>
   <demo.snippet @label="content.hbs" @name="context-menu-content.hbs"/>
-  <demo.snippet @label="content.js" @name="context-menu-content.js"/>
   <demo.snippet @label="custom-menu.hbs" @name="context-menu-custom-menu.hbs"/>
 </DocsDemo>

tests/dummy/app/components/demo-context-menu.hbs

@@ -1204,7 +1204,7 @@
     "@ember-decorators/utils" "^6.1.1"
     ember-cli-babel "^7.1.3"
 
-"@ember-decorators/utils@^6.1.1":
+"@ember-decorators/utils@^6.1.0", "@ember-decorators/utils@^6.1.1":
   version "6.1.1"
   resolved "https://registry.yarnpkg.com/@ember-decorators/utils/-/utils-6.1.1.tgz#6b619814942b4fb3747cfa9f540c9f05283d7c5e"
   integrity sha512-0KqnoeoLKb6AyoSU65TRF5T85wmS4uDn06oARddwNPxxf/lt5jQlh41uX3W7V/fWL9tPu8x1L1Vvpc80MN1+YA==
@@ -3219,6 +3219,11 @@ babel-plugin-filter-imports@^4.0.0:
     "@babel/types" "^7.7.2"
     lodash "^4.17.15"
 
+babel-plugin-htmlbars-inline-precompile@^3.2.0:
+  version "3.2.0"
+  resolved "https://registry.yarnpkg.com/babel-plugin-htmlbars-inline-precompile/-/babel-plugin-htmlbars-inline-precompile-3.2.0.tgz#c4882ea875d0f5683f0d91c1f72e29a4f14b5606"
+  integrity sha512-IUeZmgs9tMUGXYu1vfke5I18yYJFldFGdNFQOWslXTnDWXzpwPih7QFduUqvT+awDpDuNtXpdt5JAf43Q1Hhzg==
+
 babel-plugin-htmlbars-inline-precompile@^4.2.0:
   version "4.4.6"
   resolved "https://registry.yarnpkg.com/babel-plugin-htmlbars-inline-precompile/-/babel-plugin-htmlbars-inline-precompile-4.4.6.tgz#9fd632ad2717226b90bde6940b4148b3a323fddb"
@@ -4400,7 +4405,7 @@ broccoli-plugin@^2.0.0, broccoli-plugin@^2.1.0:
     rimraf "^2.3.4"
     symlink-or-copy "^1.1.8"
 
-broccoli-plugin@^3.0.0:
+broccoli-plugin@^3.0.0, broccoli-plugin@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/broccoli-plugin/-/broccoli-plugin-3.1.0.tgz#54ba6dd90a42ec3db5624063292610e326b1e542"
   integrity sha512-7w7FP8WJYjLvb0eaw27LO678TGGaom++49O1VYIuzjhXjK5kn2+AMlDm7CaUFw4F7CLGoVQeZ84d8gICMJa4lA==
@@ -6581,6 +6586,26 @@ ember-cli-htmlbars@^3.0.1:
     json-stable-stringify "^1.0.1"
     strip-bom "^3.0.0"
 
+ember-cli-htmlbars@^4.2.3, ember-cli-htmlbars@^4.3.1:
+  version "4.5.0"
+  resolved "https://registry.yarnpkg.com/ember-cli-htmlbars/-/ember-cli-htmlbars-4.5.0.tgz#d299e4f7eba6f30dc723ee086906cc550beb252e"
+  integrity sha512-bYJpK1pqFu9AadDAGTw05g2LMNzY8xTCIqQm7dMJmKEoUpLRFbPf4SfHXrktzDh7Q5iggl6Skzf1M0bPlIxARw==
+  dependencies:
+    "@ember/edition-utils" "^1.2.0"
+    babel-plugin-htmlbars-inline-precompile "^3.2.0"
+    broccoli-debug "^0.6.5"
+    broccoli-persistent-filter "^2.3.1"
+    broccoli-plugin "^3.1.0"
+    common-tags "^1.8.0"
+    ember-cli-babel-plugin-helpers "^1.1.0"
+    fs-tree-diff "^2.0.1"
+    hash-for-dep "^1.5.1"
+    heimdalljs-logger "^0.1.10"
+    json-stable-stringify "^1.0.1"
+    semver "^6.3.0"
+    strip-bom "^4.0.0"
+    walk-sync "^2.0.2"
+
 ember-cli-htmlbars@^5.0.0:
   version "5.3.1"
   resolved "https://registry.yarnpkg.com/ember-cli-htmlbars/-/ember-cli-htmlbars-5.3.1.tgz#61793964fc2599ce750db9e972ab55c6dd177c48"
@@ -6951,6 +6976,15 @@ ember-cli@~3.28.4:
     workerpool "^6.1.4"
     yam "^1.0.0"
 
+ember-click-outside@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/ember-click-outside/-/ember-click-outside-2.0.0.tgz#4b056a1f737ed2b2c933b05fff7b3501c967cd8f"
+  integrity sha512-d53L+Of9rRhB8RU32xKFDG58e8MJZRPFF9HAuUIcn3Hl5U7v8Gb9YqB59khcryCkRXWzLOvVgmNFjNaV9iZJyQ==
+  dependencies:
+    ember-cli-babel "^7.18.0"
+    ember-cli-htmlbars "^4.2.3"
+    ember-modifier "^2.1.0"
+
 ember-code-snippet@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/ember-code-snippet/-/ember-code-snippet-3.0.0.tgz#5e3108a68cc76740355cbbca840656d96c6b7ba1"
@@ -6984,6 +7018,16 @@ ember-composable-helpers@^4.4.1:
     ember-cli-babel "^7.11.1"
     resolve "^1.10.0"
 
+ember-concurrency-decorators@^2.0.3:
+  version "2.0.3"
+  resolved "https://registry.yarnpkg.com/ember-concurrency-decorators/-/ember-concurrency-decorators-2.0.3.tgz#2816c9a0283b90ba5340fc5b4e0b92ea91f7d6e3"
+  integrity sha512-r6O34YKI/slyYapVsuOPnmaKC4AsmBSwvgcadbdy+jHNj+mnryXPkm+3hhhRnFdlsKUKdEuXvl43lhjhYRLhhA==
+  dependencies:
+    "@ember-decorators/utils" "^6.1.0"
+    ember-cli-babel "^7.19.0"
+    ember-cli-htmlbars "^4.3.1"
+    ember-cli-typescript "^3.1.4"
+
 ember-concurrency@^2.0.0, ember-concurrency@^2.1.2, ember-concurrency@^2.2.0:
   version "2.2.0"
   resolved "https://registry.yarnpkg.com/ember-concurrency/-/ember-concurrency-2.2.0.tgz#0acfb8ca855e0fdfa4c543be150028299a89ba32"
@@ -7047,6 +7091,13 @@ ember-element-helper@^0.5.0, ember-element-helper@^0.5.5:
     ember-cli-babel "^7.17.2"
     ember-cli-htmlbars "^5.1.0"
 
+ember-event-helpers@^0.1.1:
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/ember-event-helpers/-/ember-event-helpers-0.1.1.tgz#8df141306c927b9d1a7bc63d63095e92c0ba90a1"
+  integrity sha512-fWcbWd4W4nRv8bbato8JB6oGRpATkR+oGYxMIqnfgTgPWaCS0ww7CuUVNpwg1TulojKMCuTXi8Fem2b1NSF1ZQ==
+  dependencies:
+    ember-cli-babel "^7.19.0"
+
 ember-export-application-global@^2.0.1:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/ember-export-application-global/-/ember-export-application-global-2.0.1.tgz#b120a70e322ab208defc9e2daebe8d0dfc2dcd46"