@instructure/ui-tree-browser 8.11.2-snapshot.7 → 8.12.0

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.12.0](https://github.com/instructure/instructure-ui/compare/v8.11.1...v8.12.0) (2021-11-17)
+
+**Note:** Version bump only for package @instructure/ui-tree-browser
+
 ## [8.11.1](https://github.com/instructure/instructure-ui/compare/v8.11.0...v8.11.1) (2021-10-19)
 
 **Note:** Version bump only for package @instructure/ui-tree-browser

package/es/TreeBrowser/index.js

@@ -128,6 +128,10 @@ let TreeBrowser = (_dec = withStyle(generateStyles, generateComponentTheme), _de
     (_this$props$makeStyle2 = (_this$props3 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props3);
   }
 
+  get _root() {
+    return this.ref;
+  }
+
   get collections() {
     const _this$props4 = this.props,
           collections = _this$props4.collections,
@@ -185,7 +189,7 @@ let TreeBrowser = (_dec = withStyle(generateStyles, generateComponentTheme), _de
   }
 
   getNavigableNodes() {
-    return Array.from(this._root.querySelectorAll('[role="treeitem"]'));
+    return Array.from(this.ref.querySelectorAll('[role="treeitem"]'));
   }
 
   moveFocus(delta) {
@@ -218,7 +222,7 @@ let TreeBrowser = (_dec = withStyle(generateStyles, generateComponentTheme), _de
   }
 
   handleLeftOrRightArrow(keyCode, node) {
-    const ltr = !(this._root.parentElement.dir === 'rtl' || document.dir === 'rtl');
+    const ltr = !(this.ref.parentElement.dir === 'rtl' || document.dir === 'rtl');
 
     if (ltr && keyCode === keycode.codes.left || !ltr && keyCode == keycode.codes.right) {
       this.handleCloseOrPrevious(node);
@@ -312,8 +316,6 @@ let TreeBrowser = (_dec = withStyle(generateStyles, generateComponentTheme), _de
       role: "tree",
       onKeyDown: this.handleKeyDown,
       ref: el => {
-        this._root = el; // TODO remove this and keep only 'ref' in V9
-
         this.ref = el;
       },
       "aria-label": this.props.treeLabel

package/es/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/lib/TreeBrowser/index.js

@@ -127,6 +127,10 @@ let TreeBrowser = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
     (_this$props$makeStyle2 = (_this$props3 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props3);
   }
 
+  get _root() {
+    return this.ref;
+  }
+
   get collections() {
     const _this$props4 = this.props,
           collections = _this$props4.collections,
@@ -184,7 +188,7 @@ let TreeBrowser = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
   }
 
   getNavigableNodes() {
-    return Array.from(this._root.querySelectorAll('[role="treeitem"]'));
+    return Array.from(this.ref.querySelectorAll('[role="treeitem"]'));
   }
 
   moveFocus(delta) {
@@ -217,7 +221,7 @@ let TreeBrowser = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
   }
 
   handleLeftOrRightArrow(keyCode, node) {
-    const ltr = !(this._root.parentElement.dir === 'rtl' || document.dir === 'rtl');
+    const ltr = !(this.ref.parentElement.dir === 'rtl' || document.dir === 'rtl');
 
     if (ltr && keyCode === _keycode.default.codes.left || !ltr && keyCode == _keycode.default.codes.right) {
       this.handleCloseOrPrevious(node);
@@ -311,8 +315,6 @@ let TreeBrowser = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
       role: "tree",
       onKeyDown: this.handleKeyDown,
       ref: el => {
-        this._root = el; // TODO remove this and keep only 'ref' in V9
-
         this.ref = el;
       },
       "aria-label": this.props.treeLabel

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-tree-browser",
-  "version": "8.11.2-snapshot.7+2681e145a",
+  "version": "8.12.0",
   "description": "A component for displaying a hierarchical view of information",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -24,22 +24,22 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-color-utils": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-test-locator": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-test-utils": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-themes": "8.11.2-snapshot.7+2681e145a"
+    "@instructure/ui-babel-preset": "8.12.0",
+    "@instructure/ui-color-utils": "8.12.0",
+    "@instructure/ui-test-locator": "8.12.0",
+    "@instructure/ui-test-utils": "8.12.0",
+    "@instructure/ui-themes": "8.12.0"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/emotion": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/shared-types": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-icons": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-img": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-prop-types": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-react-utils": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-testable": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-utils": "8.11.2-snapshot.7+2681e145a",
+    "@instructure/emotion": "8.12.0",
+    "@instructure/shared-types": "8.12.0",
+    "@instructure/ui-icons": "8.12.0",
+    "@instructure/ui-img": "8.12.0",
+    "@instructure/ui-prop-types": "8.12.0",
+    "@instructure/ui-react-utils": "8.12.0",
+    "@instructure/ui-testable": "8.12.0",
+    "@instructure/ui-utils": "8.12.0",
     "keycode": "^2",
     "prop-types": "^15"
   },
@@ -49,6 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "2681e145ad469e1396536d3e9eed75a19995eb8a"
+  "sideEffects": false
 }

package/src/TreeBrowser/index.tsx

@@ -98,6 +98,13 @@ class TreeBrowser extends Component<TreeBrowserProps> {
   componentDidUpdate() {
     this.props.makeStyles?.()
   }
+  get _root() {
+    console.warn(
+      '_root property is deprecated and will be removed in v9, please use ref instead'
+    )
+
+    return this.ref
+  }
 
   // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'e' implicitly has an 'any' type.
   handleCollectionClick = (e, collection, expand = true) => {
@@ -210,8 +217,7 @@ class TreeBrowser extends Component<TreeBrowserProps> {
   }
 
   getNavigableNodes() {
-    // @ts-expect-error ts-migrate(2339) FIXME: Property '_root' does not exist on type 'TreeBrows... Remove this comment to see the full error message
-    return Array.from(this._root.querySelectorAll('[role="treeitem"]'))
+    return Array.from(this.ref!.querySelectorAll('[role="treeitem"]'))
   }
 
   // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'delta' implicitly has an 'any' type.
@@ -219,7 +225,7 @@ class TreeBrowser extends Component<TreeBrowserProps> {
     const nodes = this.getNavigableNodes()
     // @ts-expect-error ts-migrate(2531) FIXME: Object is possibly 'null'.
     const closest = window.document.activeElement.closest('[role="treeitem"]')
-    const active = nodes.indexOf(closest)
+    const active = nodes.indexOf(closest!)
     let next = active + delta
     if (next < 0) {
       next = 0
@@ -227,10 +233,8 @@ class TreeBrowser extends Component<TreeBrowserProps> {
       next = nodes.length - 1
     }
     nodes.forEach((n) => {
-      // @ts-expect-error ts-migrate(2571) FIXME: Object is of type 'unknown'.
       n.setAttribute('tabindex', '-1')
     })
-    // @ts-expect-error ts-migrate(2571) FIXME: Object is of type 'unknown'.
     nodes[next].setAttribute('tabindex', '0')
     // @ts-expect-error ts-migrate(2571) FIXME: Object is of type 'unknown'.
     nodes[next].focus()
@@ -249,8 +253,8 @@ class TreeBrowser extends Component<TreeBrowserProps> {
   // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'keyCode' implicitly has an 'any' type.
   handleLeftOrRightArrow(keyCode, node) {
     const ltr = !(
-      // @ts-expect-error ts-migrate(2339) FIXME: Property '_root' does not exist on type 'TreeBrows... Remove this comment to see the full error message
-      (this._root.parentElement.dir === 'rtl' || document.dir === 'rtl')
+      // @ts-expect-error ts-migrate(2339) FIXME: Property 'ref' is possibly null
+      (this.ref.parentElement.dir === 'rtl' || document.dir === 'rtl')
     )
     if (
       (ltr && keyCode === keycode.codes.left) ||
@@ -385,8 +389,6 @@ class TreeBrowser extends Component<TreeBrowserProps> {
         // @ts-expect-error ts-migrate(2322) FIXME: Type '(event: any, node: any) => void' is not assi... Remove this comment to see the full error message
         onKeyDown={this.handleKeyDown}
         ref={(el) => {
-          // @ts-expect-error ts-migrate(2339) FIXME: Property '_root' does not exist on type 'TreeBrows... Remove this comment to see the full error message
-          this._root = el // TODO remove this and keep only 'ref' in V9
           this.ref = el
         }}
         aria-label={this.props.treeLabel}

package/types/TreeBrowser/index.d.ts

@@ -77,6 +77,7 @@ declare class TreeBrowser extends Component<TreeBrowserProps> {
     constructor(props: any);
     componentDidMount(): void;
     componentDidUpdate(): void;
+    get _root(): Element | null;
     handleCollectionClick: (e: any, collection: any, expand?: boolean) => void;
     handleItemClick: (e: any, item: any) => void;
     handleKeyDown: (event: any, node: any) => void;
@@ -85,7 +86,7 @@ declare class TreeBrowser extends Component<TreeBrowserProps> {
     getExpanded(state: any, props: any): any;
     expandOrCollapseNode(collection: any): void;
     handleSelection(id: any, type: any): void;
-    getNavigableNodes(): unknown[];
+    getNavigableNodes(): Element[];
     moveFocus(delta: any): void;
     homeOrEnd(keyCode: any): void;
     handleLeftOrRightArrow(keyCode: any, node: any): void;

package/types/TreeBrowser/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/TreeBrowser/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AAEf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAGjC,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAIxE,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAIrC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAG/C;;;;GAIG;AACH,cAEM,WAAY,SAAQ,SAAS,CAAC,gBAAgB,CAAC;IACnD,MAAM,CAAC,QAAQ,CAAC,WAAW,iBAAgB;IAE3C,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;MAmBlB;IAED,MAAM,CAAC,IAAI,kBAAW;IACtB,MAAM,CAAC,UAAU,wBAAiB;IAClC,MAAM,CAAC,MAAM,oBAAa;IAC1B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;gBAGd,KAAK,KAAA;IAUjB,iBAAiB;IAGjB,kBAAkB;IAKlB,qBAAqB,sDAQpB;IAGD,eAAe,8BAMd;IAGD,aAAa,kCA2BZ;IAED,IAAI,WAAW,UAUd;IAED,IAAI,QAAQ,QAEX;IAGD,WAAW,CAAC,KAAK,KAAA,EAAE,KAAK,KAAA;IAOxB,oBAAoB,CAAC,UAAU,KAAA;IAsB/B,eAAe,CAAC,EAAE,KAAA,EAAE,IAAI,KAAA;IAcxB,iBAAiB;IAMjB,SAAS,CAAC,KAAK,KAAA;IAsBf,SAAS,CAAC,OAAO,KAAA;IAUjB,sBAAsB,CAAC,OAAO,KAAA,EAAE,IAAI,KAAA;IAgBpC,gBAAgB,CAAC,IAAI,KAAA;IAarB,qBAAqB,CAAC,IAAI,KAAA;IAS1B,gBAAgB,CAAC,KAAK,KAAA,EAAE,IAAI,KAAA;IAc5B,iBAAiB,CAAC,UAAU,KAAA;IAS5B,QAAQ,CAAC,UAAU,KAAA;IAenB,cAAc,+BAOb;IAGD,kBAAkB,CAAC,UAAU,KAAA;IAgB7B,gBAAgB,CAAC,QAAQ,KAAA,EAAE,EAAE,KAAA;IAK7B,UAAU;IAoBV,MAAM;CAqBP;AAED,eAAe,WAAW,CAAA;AAC1B,OAAO,EAAE,WAAW,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/TreeBrowser/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AAEf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAGjC,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAIxE,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAIrC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAG/C;;;;GAIG;AACH,cAEM,WAAY,SAAQ,SAAS,CAAC,gBAAgB,CAAC;IACnD,MAAM,CAAC,QAAQ,CAAC,WAAW,iBAAgB;IAE3C,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;MAmBlB;IAED,MAAM,CAAC,IAAI,kBAAW;IACtB,MAAM,CAAC,UAAU,wBAAiB;IAClC,MAAM,CAAC,MAAM,oBAAa;IAC1B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;gBAGd,KAAK,KAAA;IAUjB,iBAAiB;IAGjB,kBAAkB;IAGlB,IAAI,KAAK,mBAMR;IAGD,qBAAqB,sDAQpB;IAGD,eAAe,8BAMd;IAGD,aAAa,kCA2BZ;IAED,IAAI,WAAW,UAUd;IAED,IAAI,QAAQ,QAEX;IAGD,WAAW,CAAC,KAAK,KAAA,EAAE,KAAK,KAAA;IAOxB,oBAAoB,CAAC,UAAU,KAAA;IAsB/B,eAAe,CAAC,EAAE,KAAA,EAAE,IAAI,KAAA;IAcxB,iBAAiB;IAKjB,SAAS,CAAC,KAAK,KAAA;IAoBf,SAAS,CAAC,OAAO,KAAA;IAUjB,sBAAsB,CAAC,OAAO,KAAA,EAAE,IAAI,KAAA;IAgBpC,gBAAgB,CAAC,IAAI,KAAA;IAarB,qBAAqB,CAAC,IAAI,KAAA;IAS1B,gBAAgB,CAAC,KAAK,KAAA,EAAE,IAAI,KAAA;IAc5B,iBAAiB,CAAC,UAAU,KAAA;IAS5B,QAAQ,CAAC,UAAU,KAAA;IAenB,cAAc,+BAOb;IAGD,kBAAkB,CAAC,UAAU,KAAA;IAgB7B,gBAAgB,CAAC,QAAQ,KAAA,EAAE,EAAE,KAAA;IAK7B,UAAU;IAoBV,MAAM;CAmBP;AAED,eAAe,WAAW,CAAA;AAC1B,OAAO,EAAE,WAAW,EAAE,CAAA"}

package/LICENSE.md

@@ -1,27 +0,0 @@
----
-title: The MIT License (MIT)
-category: Getting Started
-order: 9
----
-
-# The MIT License (MIT)
-
-Copyright (c) 2015 Instructure, Inc.
-
-**Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions.**
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.