@instructure/ui-truncate-text 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-truncate-text
+
 ## [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-truncate-text

package/es/TruncateText/index.js

@@ -48,7 +48,7 @@ let TruncateText = (_dec = withStyle(generateStyle, generateComponentTheme), _de
     this.ref = null;
 
     this.update = () => {
-      if (this._ref) {
+      if (this.ref) {
         this.setState(this.initialState);
       }
     };
@@ -56,6 +56,10 @@ let TruncateText = (_dec = withStyle(generateStyle, generateComponentTheme), _de
     this.state = this.initialState;
   }
 
+  get _ref() {
+    return this.ref;
+  }
+
   get initialState() {
     return {
       isTruncated: false,
@@ -80,7 +84,7 @@ let TruncateText = (_dec = withStyle(generateStyle, generateComponentTheme), _de
         trailing: true
       });
 
-      const _getBoundingClientRec = getBoundingClientRect(this._ref),
+      const _getBoundingClientRec = getBoundingClientRect(this.ref),
             origWidth = _getBoundingClientRec.width;
 
       this._resizeListener = new ResizeObserver(entries => {
@@ -98,7 +102,7 @@ let TruncateText = (_dec = withStyle(generateStyle, generateComponentTheme), _de
         });
       });
 
-      this._resizeListener.observe(this._ref);
+      this._resizeListener.observe(this.ref);
     }
   }
 
@@ -173,7 +177,7 @@ let TruncateText = (_dec = withStyle(generateStyle, generateComponentTheme), _de
       var _this$props$styles;
 
       const result = truncate(this._stage, { ...this.props,
-        parent: this._ref,
+        parent: this.ref,
         lineHeight: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.lineHeight
       });
 
@@ -187,12 +191,14 @@ let TruncateText = (_dec = withStyle(generateStyle, generateComponentTheme), _de
         });
       }
     } else {
+      var _this$ref;
+
       // if dom isn't available, use original children
       this.setState({
         needsSecondRender: false,
         isTruncated: false,
         truncatedElement: this._text,
-        truncatedText: this._ref.textContent
+        truncatedText: (_this$ref = this.ref) === null || _this$ref === void 0 ? void 0 : _this$ref.textContent
       });
     }
   }
@@ -239,8 +245,6 @@ let TruncateText = (_dec = withStyle(generateStyle, generateComponentTheme), _de
     return jsx("span", {
       css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.truncateText,
       ref: el => {
-        this._ref = el; // TODO remove this and keep only 'ref' in V9
-
         this.ref = el;
       }
     }, children && (truncatedElement ? null : jsx("span", {

package/es/package.json

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

package/lib/TruncateText/index.js

@@ -50,7 +50,7 @@ let TruncateText = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defau
     this.ref = null;
 
     this.update = () => {
-      if (this._ref) {
+      if (this.ref) {
         this.setState(this.initialState);
       }
     };
@@ -58,6 +58,10 @@ let TruncateText = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defau
     this.state = this.initialState;
   }
 
+  get _ref() {
+    return this.ref;
+  }
+
   get initialState() {
     return {
       isTruncated: false,
@@ -82,7 +86,7 @@ let TruncateText = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defau
         trailing: true
       });
 
-      const _getBoundingClientRec = (0, _getBoundingClientRect.getBoundingClientRect)(this._ref),
+      const _getBoundingClientRec = (0, _getBoundingClientRect.getBoundingClientRect)(this.ref),
             origWidth = _getBoundingClientRec.width;
 
       this._resizeListener = new ResizeObserver(entries => {
@@ -100,7 +104,7 @@ let TruncateText = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defau
         });
       });
 
-      this._resizeListener.observe(this._ref);
+      this._resizeListener.observe(this.ref);
     }
   }
 
@@ -177,7 +181,7 @@ let TruncateText = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defau
       var _this$props$styles;
 
       const result = (0, _truncate.default)(this._stage, { ...this.props,
-        parent: this._ref,
+        parent: this.ref,
         lineHeight: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.lineHeight
       });
 
@@ -191,12 +195,14 @@ let TruncateText = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defau
         });
       }
     } else {
+      var _this$ref;
+
       // if dom isn't available, use original children
       this.setState({
         needsSecondRender: false,
         isTruncated: false,
         truncatedElement: this._text,
-        truncatedText: this._ref.textContent
+        truncatedText: (_this$ref = this.ref) === null || _this$ref === void 0 ? void 0 : _this$ref.textContent
       });
     }
   }
@@ -245,8 +251,6 @@ let TruncateText = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defau
     return (0, _emotion.jsx)("span", {
       css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.truncateText,
       ref: el => {
-        this._ref = el; // TODO remove this and keep only 'ref' in V9
-
         this.ref = el;
       }
     }, children && (truncatedElement ? null : (0, _emotion.jsx)("span", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-truncate-text",
-  "version": "8.11.2-snapshot.7+2681e145a",
+  "version": "8.12.0",
   "description": "A TruncateText component made by Instructure Inc.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -25,23 +25,23 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/debounce": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/emotion": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/shared-types": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-dom-utils": "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/console": "8.12.0",
+    "@instructure/debounce": "8.12.0",
+    "@instructure/emotion": "8.12.0",
+    "@instructure/shared-types": "8.12.0",
+    "@instructure/ui-dom-utils": "8.12.0",
+    "@instructure/ui-react-utils": "8.12.0",
+    "@instructure/ui-testable": "8.12.0",
+    "@instructure/ui-utils": "8.12.0",
     "escape-html": "^1",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-color-utils": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-test-utils": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-text": "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-utils": "8.12.0",
+    "@instructure/ui-text": "8.12.0",
+    "@instructure/ui-themes": "8.12.0"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -49,6 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "2681e145ad469e1396536d3e9eed75a19995eb8a"
+  "sideEffects": false
 }

package/src/TruncateText/index.tsx

@@ -74,6 +74,13 @@ class TruncateText extends Component<TruncateTextProps> {
     super(props)
     this.state = this.initialState
   }
+  get _ref() {
+    console.warn(
+      '_ref property is deprecated and will be removed in v9, please use ref instead'
+    )
+
+    return this.ref
+  }
 
   get initialState() {
     return {
@@ -103,8 +110,7 @@ class TruncateText extends Component<TruncateTextProps> {
         trailing: true
       })
 
-      // @ts-expect-error ts-migrate(2339) FIXME: Property 'width' does not exist on type '{}'.
-      const { width: origWidth } = getBoundingClientRect(this._ref)
+      const { width: origWidth } = getBoundingClientRect(this.ref)
       // @ts-expect-error ts-migrate(2339) FIXME: Property '_resizeListener' does not exist on type ... Remove this comment to see the full error message
       this._resizeListener = new ResizeObserver((entries) => {
         // requestAnimationFrame call is needed becuase some truncatetext test cases
@@ -123,7 +129,7 @@ class TruncateText extends Component<TruncateTextProps> {
       })
 
       // @ts-expect-error ts-migrate(2339) FIXME: Property '_resizeListener' does not exist on type ... Remove this comment to see the full error message
-      this._resizeListener.observe(this._ref)
+      this._resizeListener.observe(this.ref)
     }
   }
 
@@ -199,8 +205,7 @@ class TruncateText extends Component<TruncateTextProps> {
   }
 
   update = () => {
-    // @ts-expect-error ts-migrate(2339) FIXME: Property '_ref' does not exist on type 'TruncateTe... Remove this comment to see the full error message
-    if (this._ref) {
+    if (this.ref) {
       this.setState(this.initialState)
     }
   }
@@ -215,8 +220,7 @@ class TruncateText extends Component<TruncateTextProps> {
       // @ts-expect-error ts-migrate(2339) FIXME: Property '_stage' does not exist on type 'Truncate... Remove this comment to see the full error message
       const result = truncate(this._stage, {
         ...this.props,
-        // @ts-expect-error ts-migrate(2339) FIXME: Property '_ref' does not exist on type 'TruncateTe... Remove this comment to see the full error message
-        parent: this._ref,
+        parent: this.ref,
         lineHeight: this.props.styles?.lineHeight
       })
       if (result) {
@@ -239,8 +243,7 @@ class TruncateText extends Component<TruncateTextProps> {
         isTruncated: false,
         // @ts-expect-error ts-migrate(2339) FIXME: Property '_text' does not exist on type 'TruncateT... Remove this comment to see the full error message
         truncatedElement: this._text,
-        // @ts-expect-error ts-migrate(2339) FIXME: Property '_ref' does not exist on type 'TruncateTe... Remove this comment to see the full error message
-        truncatedText: this._ref.textContent
+        truncatedText: this.ref?.textContent
       })
     }
   }
@@ -290,8 +293,6 @@ class TruncateText extends Component<TruncateTextProps> {
       <span
         css={this.props.styles?.truncateText}
         ref={(el) => {
-          // @ts-expect-error ts-migrate(2339) FIXME: Property '_ref' does not exist on type 'TruncateTe... Remove this comment to see the full error message
-          this._ref = el // TODO remove this and keep only 'ref' in V9
           this.ref = el
         }}
       >

package/types/TruncateText/index.d.ts

@@ -42,6 +42,7 @@ declare class TruncateText extends Component<TruncateTextProps> {
     };
     ref: Element | null;
     constructor(props: any);
+    get _ref(): Element | null;
     get initialState(): {
         isTruncated: boolean;
         needsSecondRender: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/TruncateText/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAWxC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAOrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEhD;;;;GAIG;AACH,cAGM,YAAa,SAAQ,SAAS,CAAC,iBAAiB,CAAC;IACrD,MAAM,CAAC,QAAQ,CAAC,WAAW,kBAAiB;IAE5C,MAAM,CAAC,YAAY;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;MASlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;gBAGd,KAAK,KAAA;IAKjB,IAAI,YAAY;;;;;MAOf;IAED,iBAAiB;IA2CjB,oBAAoB;IAepB,kBAAkB,CAAC,SAAS,KAAA;IAkC5B,aAAa;IAsBb,MAAM,aAKL;IAED,QAAQ;IAyCR,cAAc,CAAC,SAAS,KAAA,EAAE,IAAI,KAAA,EAAE,KAAK,KAAA;IAmCrC,MAAM;CA6BP;AAED,eAAe,YAAY,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/TruncateText/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAWxC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAOrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEhD;;;;GAIG;AACH,cAGM,YAAa,SAAQ,SAAS,CAAC,iBAAiB,CAAC;IACrD,MAAM,CAAC,QAAQ,CAAC,WAAW,kBAAiB;IAE5C,MAAM,CAAC,YAAY;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;MASlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;gBAGd,KAAK,KAAA;IAIjB,IAAI,IAAI,mBAMP;IAED,IAAI,YAAY;;;;;MAOf;IAED,iBAAiB;IA0CjB,oBAAoB;IAepB,kBAAkB,CAAC,SAAS,KAAA;IAkC5B,aAAa;IAsBb,MAAM,aAIL;IAED,QAAQ;IAuCR,cAAc,CAAC,SAAS,KAAA,EAAE,IAAI,KAAA,EAAE,KAAK,KAAA;IAmCrC,MAAM;CA2BP;AAED,eAAe,YAAY,CAAA;AAC3B,OAAO,EAAE,YAAY,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.