@instructure/ui-dialog 8.10.1 → 8.10.3-snapshot.3

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.10.2](https://github.com/instructure/instructure-ui/compare/v8.10.1...v8.10.2) (2021-10-01)
+
+**Note:** Version bump only for package @instructure/ui-dialog
+
 ## [8.10.1](https://github.com/instructure/instructure-ui/compare/v8.10.0...v8.10.1) (2021-10-01)
 
 **Note:** Version bump only for package @instructure/ui-dialog

package/LICENSE.md

@@ -0,0 +1,27 @@
+---
+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.

package/es/Dialog/index.js

@@ -43,9 +43,16 @@ class Dialog extends Component {
     this._timeouts = [];
     this._raf = [];
     this._focusRegion = null;
+    this.ref = null;
+    this._root = null;
 
     this.getRef = el => {
+      var _this$props$elementRe, _this$props;
+
+      // TODO: deprecate _root? ref should be enough
       this._root = el;
+      this.ref = el;
+      (_this$props$elementRe = (_this$props = this.props).elementRef) === null || _this$props$elementRe === void 0 ? void 0 : _this$props$elementRe.call(_this$props, el);
     };
   }
 
@@ -84,10 +91,10 @@ class Dialog extends Component {
   }
 
   open() {
-    const _this$props = this.props,
-          open = _this$props.open,
-          contentElement = _this$props.contentElement,
-          options = _objectWithoutProperties(_this$props, _excluded);
+    const _this$props2 = this.props,
+          open = _this$props2.open,
+          contentElement = _this$props2.contentElement,
+          options = _objectWithoutProperties(_this$props2, _excluded);
 
     this._raf.push(requestAnimationFrame(() => {
       // It needs to wait a heartbeat until the content is fully loaded

package/es/Dialog/props.js

@@ -67,7 +67,8 @@ const propTypes = {
   shouldReturnFocus: PropTypes.bool,
   shouldCloseOnDocumentClick: PropTypes.bool,
   shouldCloseOnEscape: PropTypes.bool,
-  shouldFocusOnOpen: PropTypes.bool
+  shouldFocusOnOpen: PropTypes.bool,
+  elementRef: PropTypes.func
 };
-const allowedProps = ['children', 'as', 'display', 'label', 'open', 'onBlur', 'onDismiss', 'defaultFocusElement', 'contentElement', 'liveRegion', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'shouldFocusOnOpen'];
+const allowedProps = ['children', 'as', 'display', 'label', 'open', 'onBlur', 'onDismiss', 'defaultFocusElement', 'contentElement', 'liveRegion', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'shouldFocusOnOpen', 'elementRef'];
 export { propTypes, allowedProps };

package/lib/Dialog/index.js

@@ -41,9 +41,16 @@ class Dialog extends _react.Component {
     this._timeouts = [];
     this._raf = [];
     this._focusRegion = null;
+    this.ref = null;
+    this._root = null;
 
     this.getRef = el => {
+      var _this$props$elementRe, _this$props;
+
+      // TODO: deprecate _root? ref should be enough
       this._root = el;
+      this.ref = el;
+      (_this$props$elementRe = (_this$props = this.props).elementRef) === null || _this$props$elementRe === void 0 ? void 0 : _this$props$elementRe.call(_this$props, el);
     };
   }
 
@@ -82,10 +89,10 @@ class Dialog extends _react.Component {
   }
 
   open() {
-    const _this$props = this.props,
-          open = _this$props.open,
-          contentElement = _this$props.contentElement,
-          options = (0, _objectWithoutProperties2.default)(_this$props, _excluded);
+    const _this$props2 = this.props,
+          open = _this$props2.open,
+          contentElement = _this$props2.contentElement,
+          options = (0, _objectWithoutProperties2.default)(_this$props2, _excluded);
 
     this._raf.push((0, _requestAnimationFrame.requestAnimationFrame)(() => {
       // It needs to wait a heartbeat until the content is fully loaded

package/lib/Dialog/props.js

@@ -77,8 +77,9 @@ const propTypes = {
   shouldReturnFocus: _propTypes.default.bool,
   shouldCloseOnDocumentClick: _propTypes.default.bool,
   shouldCloseOnEscape: _propTypes.default.bool,
-  shouldFocusOnOpen: _propTypes.default.bool
+  shouldFocusOnOpen: _propTypes.default.bool,
+  elementRef: _propTypes.default.func
 };
 exports.propTypes = propTypes;
-const allowedProps = ['children', 'as', 'display', 'label', 'open', 'onBlur', 'onDismiss', 'defaultFocusElement', 'contentElement', 'liveRegion', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'shouldFocusOnOpen'];
+const allowedProps = ['children', 'as', 'display', 'label', 'open', 'onBlur', 'onDismiss', 'defaultFocusElement', 'contentElement', 'liveRegion', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'shouldFocusOnOpen', 'elementRef'];
 exports.allowedProps = allowedProps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-dialog",
-  "version": "8.10.1",
+  "version": "8.10.3-snapshot.3+2ee813492",
   "description": "A utility component for managing keyboard accessibility and screen reader behavior",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -25,18 +25,18 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/shared-types": "8.10.1",
-    "@instructure/ui-a11y-utils": "8.10.1",
-    "@instructure/ui-dom-utils": "8.10.1",
-    "@instructure/ui-react-utils": "8.10.1",
-    "@instructure/ui-testable": "8.10.1",
+    "@instructure/shared-types": "8.10.3-snapshot.3+2ee813492",
+    "@instructure/ui-a11y-utils": "8.10.3-snapshot.3+2ee813492",
+    "@instructure/ui-dom-utils": "8.10.3-snapshot.3+2ee813492",
+    "@instructure/ui-react-utils": "8.10.3-snapshot.3+2ee813492",
+    "@instructure/ui-testable": "8.10.3-snapshot.3+2ee813492",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/console": "8.10.1",
-    "@instructure/ui-babel-preset": "8.10.1",
-    "@instructure/ui-prop-types": "8.10.1",
-    "@instructure/ui-test-utils": "8.10.1"
+    "@instructure/console": "8.10.3-snapshot.3+2ee813492",
+    "@instructure/ui-babel-preset": "8.10.3-snapshot.3+2ee813492",
+    "@instructure/ui-prop-types": "8.10.3-snapshot.3+2ee813492",
+    "@instructure/ui-test-utils": "8.10.3-snapshot.3+2ee813492"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -44,5 +44,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false
+  "sideEffects": false,
+  "gitHead": "2ee8134925b02efbc5d39662a8b1edb2c83a420d"
 }

package/src/Dialog/index.tsx

@@ -66,6 +66,9 @@ class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogProps>> {
   _timeouts: ReturnType<typeof setTimeout>[] = []
   _raf: RequestAnimationFrameType[] = []
   _focusRegion = null
+  ref: Element | null = null
+  _root: Element | null = null
+
   componentDidMount() {
     if (this.props.open) {
       this.open()
@@ -152,17 +155,17 @@ class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogProps>> {
     this.close()
   }
 
-  //@ts-expect-error TODO:
-  getRef = (el) => {
-    //@ts-expect-error TODO:
+  getRef = (el: Element | null) => {
+    // TODO: deprecate _root? ref should be enough
     this._root = el
+    this.ref = el
+    this.props.elementRef?.(el)
   }
 
   get contentElement() {
     let contentElement = findDOMNode(this.props.contentElement)
 
     if (!contentElement) {
-      //@ts-expect-error TODO:
       contentElement = findDOMNode(this._root)
     }
 

package/src/Dialog/props.ts

@@ -46,6 +46,7 @@ type DialogOwnProps = {
   shouldCloseOnDocumentClick?: boolean
   shouldCloseOnEscape?: boolean
   shouldFocusOnOpen?: boolean
+  elementRef?: (element: Element | null) => void
 }
 
 type PropKeys = keyof DialogOwnProps
@@ -108,7 +109,8 @@ const propTypes: PropValidators<PropKeys> = {
   shouldReturnFocus: PropTypes.bool,
   shouldCloseOnDocumentClick: PropTypes.bool,
   shouldCloseOnEscape: PropTypes.bool,
-  shouldFocusOnOpen: PropTypes.bool
+  shouldFocusOnOpen: PropTypes.bool,
+  elementRef: PropTypes.func
 }
 
 const allowedProps: AllowedPropKeys = [
@@ -126,7 +128,8 @@ const allowedProps: AllowedPropKeys = [
   'shouldReturnFocus',
   'shouldCloseOnDocumentClick',
   'shouldCloseOnEscape',
-  'shouldFocusOnOpen'
+  'shouldFocusOnOpen',
+  'elementRef'
 ]
 
 export type { DialogProps }

package/types/Dialog/index.d.ts

@@ -26,6 +26,7 @@ declare class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogP
         shouldCloseOnDocumentClick?: boolean | undefined;
         shouldCloseOnEscape?: boolean | undefined;
         shouldFocusOnOpen?: boolean | undefined;
+        elementRef?: ((element: Element | null) => void) | undefined;
     }>;
     static allowedProps: readonly (keyof {
         children?: React.ReactNode;
@@ -43,6 +44,7 @@ declare class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogP
         shouldCloseOnDocumentClick?: boolean | undefined;
         shouldCloseOnEscape?: boolean | undefined;
         shouldFocusOnOpen?: boolean | undefined;
+        elementRef?: ((element: Element | null) => void) | undefined;
     })[];
     static defaultProps: {
         readonly children: null;
@@ -61,6 +63,8 @@ declare class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogP
     _timeouts: ReturnType<typeof setTimeout>[];
     _raf: RequestAnimationFrameType[];
     _focusRegion: null;
+    ref: Element | null;
+    _root: Element | null;
     componentDidMount(): void;
     componentDidUpdate(prevProps: any): void;
     componentWillUnmount(): void;
@@ -68,8 +72,8 @@ declare class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogP
     close(): void;
     focus(): void;
     blur(): void;
-    getRef: (el: any) => void;
-    get contentElement(): Node | Window | null | undefined;
+    getRef: (el: Element | null) => void;
+    get contentElement(): Element | Node | Window | undefined;
     get focused(): null | undefined;
     render(): JSX.Element | null;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Dialog/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIxC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAE1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAIpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;;GAKG;AAEH,cAAM,MAAO,SAAQ,SAAS,CAAC,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC5E,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;;;;;;MAeT;IAEV,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,CAAK;IAC/C,IAAI,EAAE,yBAAyB,EAAE,CAAK;IACtC,YAAY,OAAO;IACnB,iBAAiB;IAOjB,kBAAkB,CAAC,SAAS,KAAA;IAe5B,oBAAoB;IAWpB,IAAI;IAyBJ,KAAK;IAOL,KAAK;IAYL,IAAI;IAUJ,MAAM,oBAGL;IAED,IAAI,cAAc,qCASjB;IAED,IAAI,OAAO,qBAOV;IAED,MAAM;CAgBP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Dialog/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIxC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAE1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAIpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;;GAKG;AAEH,cAAM,MAAO,SAAQ,SAAS,CAAC,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC5E,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;;;;;;MAeT;IAEV,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,CAAK;IAC/C,IAAI,EAAE,yBAAyB,EAAE,CAAK;IACtC,YAAY,OAAO;IACnB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAC1B,KAAK,EAAE,OAAO,GAAG,IAAI,CAAO;IAE5B,iBAAiB;IAOjB,kBAAkB,CAAC,SAAS,KAAA;IAe5B,oBAAoB;IAWpB,IAAI;IAyBJ,KAAK;IAOL,KAAK;IAYL,IAAI;IASJ,MAAM,OAAQ,OAAO,GAAG,IAAI,UAK3B;IAED,IAAI,cAAc,wCAQjB;IAED,IAAI,OAAO,qBAOV;IAED,MAAM;CAgBP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/types/Dialog/props.d.ts

@@ -16,6 +16,7 @@ declare type DialogOwnProps = {
     shouldCloseOnDocumentClick?: boolean;
     shouldCloseOnEscape?: boolean;
     shouldFocusOnOpen?: boolean;
+    elementRef?: (element: Element | null) => void;
 };
 declare type PropKeys = keyof DialogOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;

package/types/Dialog/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Dialog/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE9E,aAAK,cAAc,GAAG;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,cAAc,CAAA;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAChC,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACnC,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACpE,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC/D,UAAU,CAAC,EACP,KAAK,CAAC,YAAY,EAAE,GACpB,KAAK,CAAC,YAAY,GAClB,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC7B,kBAAkB,CAAC,EAAE,OAAO,GAAG,CAAC,UAAU,GAAG,cAAc,CAAC,CAAA;IAC5D,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,WAAW,GAAG,cAAc,CAAA;AAEjC,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAuDvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAgBnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,CAAA;AAC3B,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Dialog/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE9E,aAAK,cAAc,GAAG;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,cAAc,CAAA;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAChC,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACnC,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACpE,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC/D,UAAU,CAAC,EACP,KAAK,CAAC,YAAY,EAAE,GACpB,KAAK,CAAC,YAAY,GAClB,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC7B,kBAAkB,CAAC,EAAE,OAAO,GAAG,CAAC,UAAU,GAAG,cAAc,CAAC,CAAA;IAC5D,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,WAAW,GAAG,cAAc,CAAA;AAEjC,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAwDvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAiBnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,CAAA;AAC3B,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}