@instructure/ui-dialog 8.10.3-snapshot.19 → 8.10.3-snapshot.23

package/es/Dialog/index.js

@@ -47,12 +47,14 @@ class Dialog extends Component {
     this._root = null;
 
     this.getRef = el => {
-      var _this$props$elementRe, _this$props;
+      const elementRef = this.props.elementRef; // TODO: deprecate _root? ref should be enough
 
-      // 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);
+
+      if (typeof elementRef === 'function') {
+        elementRef(el);
+      }
     };
   }
 
@@ -91,10 +93,10 @@ class Dialog extends Component {
   }
 
   open() {
-    const _this$props2 = this.props,
-          open = _this$props2.open,
-          contentElement = _this$props2.contentElement,
-          options = _objectWithoutProperties(_this$props2, _excluded);
+    const _this$props = this.props,
+          open = _this$props.open,
+          contentElement = _this$props.contentElement,
+          options = _objectWithoutProperties(_this$props, _excluded);
 
     this._raf.push(requestAnimationFrame(() => {
       // It needs to wait a heartbeat until the content is fully loaded

package/es/Dialog/props.js

@@ -68,6 +68,10 @@ const propTypes = {
   shouldCloseOnDocumentClick: PropTypes.bool,
   shouldCloseOnEscape: PropTypes.bool,
   shouldFocusOnOpen: PropTypes.bool,
+
+  /**
+   * provides a reference to the underlying html root element
+   */
   elementRef: PropTypes.func
 };
 const allowedProps = ['children', 'as', 'display', 'label', 'open', 'onBlur', 'onDismiss', 'defaultFocusElement', 'contentElement', 'liveRegion', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'shouldFocusOnOpen', 'elementRef'];

package/lib/Dialog/index.js

@@ -45,12 +45,14 @@ class Dialog extends _react.Component {
     this._root = null;
 
     this.getRef = el => {
-      var _this$props$elementRe, _this$props;
+      const elementRef = this.props.elementRef; // TODO: deprecate _root? ref should be enough
 
-      // 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);
+
+      if (typeof elementRef === 'function') {
+        elementRef(el);
+      }
     };
   }
 
@@ -89,10 +91,10 @@ class Dialog extends _react.Component {
   }
 
   open() {
-    const _this$props2 = this.props,
-          open = _this$props2.open,
-          contentElement = _this$props2.contentElement,
-          options = (0, _objectWithoutProperties2.default)(_this$props2, _excluded);
+    const _this$props = this.props,
+          open = _this$props.open,
+          contentElement = _this$props.contentElement,
+          options = (0, _objectWithoutProperties2.default)(_this$props, _excluded);
 
     this._raf.push((0, _requestAnimationFrame.requestAnimationFrame)(() => {
       // It needs to wait a heartbeat until the content is fully loaded

package/lib/Dialog/props.js

@@ -78,6 +78,10 @@ const propTypes = {
   shouldCloseOnDocumentClick: _propTypes.default.bool,
   shouldCloseOnEscape: _propTypes.default.bool,
   shouldFocusOnOpen: _propTypes.default.bool,
+
+  /**
+   * provides a reference to the underlying html root element
+   */
   elementRef: _propTypes.default.func
 };
 exports.propTypes = propTypes;

package/package.json

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

package/src/Dialog/index.tsx

@@ -28,7 +28,6 @@ import { omitProps, getElementType } from '@instructure/ui-react-utils'
 import { findDOMNode, requestAnimationFrame } from '@instructure/ui-dom-utils'
 import type { RequestAnimationFrameType } from '@instructure/ui-dom-utils'
 import { logError as error } from '@instructure/console'
-import type { OtherHTMLAttributes } from '@instructure/shared-types'
 import { FocusRegionManager } from '@instructure/ui-a11y-utils'
 
 import { propTypes, allowedProps } from './props'
@@ -41,7 +40,7 @@ category: components/utilities
 @module Dialog
 **/
 
-class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogProps>> {
+class Dialog extends Component<DialogProps> {
   static readonly componentId = 'Dialog'
 
   static propTypes = propTypes
@@ -156,10 +155,15 @@ class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogProps>> {
   }
 
   getRef = (el: Element | null) => {
+    const { elementRef } = this.props
+
     // TODO: deprecate _root? ref should be enough
     this._root = el
     this.ref = el
-    this.props.elementRef?.(el)
+
+    if (typeof elementRef === 'function') {
+      elementRef(el)
+    }
   }
 
   get contentElement() {

package/src/Dialog/props.ts

@@ -25,7 +25,11 @@
 import React from 'react'
 import PropTypes from 'prop-types'
 
-import type { AsElementType, PropValidators } from '@instructure/shared-types'
+import type {
+  AsElementType,
+  OtherHTMLAttributes,
+  PropValidators
+} from '@instructure/shared-types'
 
 type DialogOwnProps = {
   children?: React.ReactNode
@@ -53,7 +57,7 @@ type PropKeys = keyof DialogOwnProps
 
 type AllowedPropKeys = Readonly<Array<PropKeys>>
 
-type DialogProps = DialogOwnProps
+type DialogProps = DialogOwnProps & OtherHTMLAttributes<DialogOwnProps>
 
 const propTypes: PropValidators<PropKeys> = {
   /**
@@ -110,6 +114,9 @@ const propTypes: PropValidators<PropKeys> = {
   shouldCloseOnDocumentClick: PropTypes.bool,
   shouldCloseOnEscape: PropTypes.bool,
   shouldFocusOnOpen: PropTypes.bool,
+  /**
+   * provides a reference to the underlying html root element
+   */
   elementRef: PropTypes.func
 }
 

package/types/Dialog/index.d.ts

@@ -1,6 +1,5 @@
 import React, { Component } from 'react';
 import type { RequestAnimationFrameType } from '@instructure/ui-dom-utils';
-import type { OtherHTMLAttributes } from '@instructure/shared-types';
 import type { DialogProps } from './props';
 /**
 ---
@@ -8,7 +7,7 @@ category: components/utilities
 ---
 @module Dialog
 **/
-declare class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogProps>> {
+declare class Dialog extends Component<DialogProps> {
     static readonly componentId = "Dialog";
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
         children?: React.ReactNode;

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,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"}
+{"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"}

package/types/Dialog/props.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import type { AsElementType, PropValidators } from '@instructure/shared-types';
+import type { AsElementType, OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
 declare type DialogOwnProps = {
     children?: React.ReactNode;
     as?: AsElementType;
@@ -20,7 +20,7 @@ declare type DialogOwnProps = {
 };
 declare type PropKeys = keyof DialogOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type DialogProps = DialogOwnProps;
+declare type DialogProps = DialogOwnProps & OtherHTMLAttributes<DialogOwnProps>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
 export type { DialogProps };

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;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"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Dialog/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAElC,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,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAA;AAEvE,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA2DvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAiBnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,CAAA;AAC3B,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}