@instructure/ui-dialog 8.11.2-snapshot.3 → 8.11.2-snapshot.45

package/es/Dialog/index.js

@@ -44,12 +44,9 @@ class Dialog extends Component {
     this._raf = [];
     this._focusRegion = null;
     this.ref = null;
-    this._root = null;
 
     this.getRef = el => {
-      const elementRef = this.props.elementRef; // TODO: deprecate _root? ref should be enough
-
-      this._root = el;
+      const elementRef = this.props.elementRef;
       this.ref = el;
 
       if (typeof elementRef === 'function') {
@@ -58,6 +55,10 @@ class Dialog extends Component {
     };
   }
 
+  get _root() {
+    return this.ref;
+  }
+
   componentDidMount() {
     if (this.props.open) {
       this.open();
@@ -141,7 +142,7 @@ class Dialog extends Component {
     let contentElement = findDOMNode(this.props.contentElement);
 
     if (!contentElement) {
-      contentElement = findDOMNode(this._root);
+      contentElement = findDOMNode(this.ref);
     }
 
     return contentElement;
@@ -152,9 +153,11 @@ class Dialog extends Component {
   }
 
   render() {
-    const ElementType = getElementType(Dialog, this.props);
+    const ElementType = getElementType(Dialog, this.props); // In case the HTML role attribute is explicitly passed, use props.role
+
+    const role = this.props.role || (this.props.label ? 'dialog' : void 0);
     return this.props.open ? /*#__PURE__*/React.createElement(ElementType, Object.assign({}, omitProps(this.props, Dialog.allowedProps), {
-      role: this.props.label ? 'dialog' : void 0,
+      role: role,
       "aria-label": this.props.label,
       className: this.props.className // eslint-disable-line react/prop-types
       ,

package/lib/Dialog/index.js

@@ -42,12 +42,9 @@ class Dialog extends _react.Component {
     this._raf = [];
     this._focusRegion = null;
     this.ref = null;
-    this._root = null;
 
     this.getRef = el => {
-      const elementRef = this.props.elementRef; // TODO: deprecate _root? ref should be enough
-
-      this._root = el;
+      const elementRef = this.props.elementRef;
       this.ref = el;
 
       if (typeof elementRef === 'function') {
@@ -56,6 +53,10 @@ class Dialog extends _react.Component {
     };
   }
 
+  get _root() {
+    return this.ref;
+  }
+
   componentDidMount() {
     if (this.props.open) {
       this.open();
@@ -139,7 +140,7 @@ class Dialog extends _react.Component {
     let contentElement = (0, _findDOMNode.findDOMNode)(this.props.contentElement);
 
     if (!contentElement) {
-      contentElement = (0, _findDOMNode.findDOMNode)(this._root);
+      contentElement = (0, _findDOMNode.findDOMNode)(this.ref);
     }
 
     return contentElement;
@@ -150,9 +151,11 @@ class Dialog extends _react.Component {
   }
 
   render() {
-    const ElementType = (0, _getElementType.getElementType)(Dialog, this.props);
+    const ElementType = (0, _getElementType.getElementType)(Dialog, this.props); // In case the HTML role attribute is explicitly passed, use props.role
+
+    const role = this.props.role || (this.props.label ? 'dialog' : void 0);
     return this.props.open ? /*#__PURE__*/_react.default.createElement(ElementType, Object.assign({}, (0, _omitProps.omitProps)(this.props, Dialog.allowedProps), {
-      role: this.props.label ? 'dialog' : void 0,
+      role: role,
       "aria-label": this.props.label,
       className: this.props.className // eslint-disable-line react/prop-types
       ,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-dialog",
-  "version": "8.11.2-snapshot.3+6c8116bbe",
+  "version": "8.11.2-snapshot.45+e3249d228",
   "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.11.2-snapshot.3+6c8116bbe",
-    "@instructure/ui-a11y-utils": "8.11.2-snapshot.3+6c8116bbe",
-    "@instructure/ui-dom-utils": "8.11.2-snapshot.3+6c8116bbe",
-    "@instructure/ui-react-utils": "8.11.2-snapshot.3+6c8116bbe",
-    "@instructure/ui-testable": "8.11.2-snapshot.3+6c8116bbe",
+    "@instructure/shared-types": "8.11.2-snapshot.45+e3249d228",
+    "@instructure/ui-a11y-utils": "8.11.2-snapshot.45+e3249d228",
+    "@instructure/ui-dom-utils": "8.11.2-snapshot.45+e3249d228",
+    "@instructure/ui-react-utils": "8.11.2-snapshot.45+e3249d228",
+    "@instructure/ui-testable": "8.11.2-snapshot.45+e3249d228",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/console": "8.11.2-snapshot.3+6c8116bbe",
-    "@instructure/ui-babel-preset": "8.11.2-snapshot.3+6c8116bbe",
-    "@instructure/ui-prop-types": "8.11.2-snapshot.3+6c8116bbe",
-    "@instructure/ui-test-utils": "8.11.2-snapshot.3+6c8116bbe"
+    "@instructure/console": "8.11.2-snapshot.45+e3249d228",
+    "@instructure/ui-babel-preset": "8.11.2-snapshot.45+e3249d228",
+    "@instructure/ui-prop-types": "8.11.2-snapshot.45+e3249d228",
+    "@instructure/ui-test-utils": "8.11.2-snapshot.45+e3249d228"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -45,5 +45,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "6c8116bbe87878c77fca03bf26de932b40e21302"
+  "gitHead": "e3249d228eabac5bb98ff5d22e5881f2fe042606"
 }

package/src/Dialog/index.tsx

@@ -66,8 +66,13 @@ class Dialog extends Component<DialogProps> {
   _raf: RequestAnimationFrameType[] = []
   _focusRegion = null
   ref: Element | null = null
-  _root: Element | null = null
+  get _root() {
+    console.warn(
+      '_root property is deprecated and will be removed in v9, please use ref instead'
+    )
 
+    return this.ref
+  }
   componentDidMount() {
     if (this.props.open) {
       this.open()
@@ -157,8 +162,6 @@ class Dialog extends Component<DialogProps> {
   getRef = (el: Element | null) => {
     const { elementRef } = this.props
 
-    // TODO: deprecate _root? ref should be enough
-    this._root = el
     this.ref = el
 
     if (typeof elementRef === 'function') {
@@ -170,7 +173,7 @@ class Dialog extends Component<DialogProps> {
     let contentElement = findDOMNode(this.props.contentElement)
 
     if (!contentElement) {
-      contentElement = findDOMNode(this._root)
+      contentElement = findDOMNode(this.ref)
     }
 
     return contentElement
@@ -188,11 +191,14 @@ class Dialog extends Component<DialogProps> {
   render() {
     const ElementType = getElementType(Dialog, this.props)
 
+    // In case the HTML role attribute is explicitly passed, use props.role
+    const role = this.props.role || (this.props.label ? 'dialog' : undefined)
+
     return this.props.open ? (
       <ElementType
         // @ts-expect-error TODO: `ref` prop causes: "Expression produces a union type that is too complex to represent.ts(2590)"
         {...omitProps(this.props, Dialog.allowedProps)}
-        role={this.props.label ? 'dialog' : undefined}
+        role={role}
         aria-label={this.props.label}
         className={this.props.className} // eslint-disable-line react/prop-types
         ref={this.getRef}

package/types/Dialog/index.d.ts

@@ -63,7 +63,7 @@ declare class Dialog extends Component<DialogProps> {
     _raf: RequestAnimationFrameType[];
     _focusRegion: null;
     ref: Element | null;
-    _root: Element | null;
+    get _root(): Element | null;
     componentDidMount(): void;
     componentDidUpdate(prevProps: any): void;
     componentWillUnmount(): void;

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;AAK1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;;GAKG;AAEH,cAAM,MAAO,SAAQ,SAAS,CAAC,WAAW,CAAC;IACzC,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,UAU3B;IAED,IAAI,cAAc,wCAQjB;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;AAK1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;;GAKG;AAEH,cAAM,MAAO,SAAQ,SAAS,CAAC,WAAW,CAAC;IACzC,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,IAAI,KAAK,mBAMR;IACD,iBAAiB;IAOjB,kBAAkB,CAAC,SAAS,KAAA;IAe5B,oBAAoB;IAWpB,IAAI;IAyBJ,KAAK;IAOL,KAAK;IAYL,IAAI;IASJ,MAAM,OAAQ,OAAO,GAAG,IAAI,UAQ3B;IAED,IAAI,cAAc,wCAQjB;IAED,IAAI,OAAO,qBAOV;IAED,MAAM;CAmBP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}