@instructure/ui-dialog 8.8.1-snapshot.7 → 8.9.1-snapshot.2

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.9.0](https://github.com/instructure/instructure-ui/compare/v8.8.0...v8.9.0) (2021-09-15)
+
+### Bug Fixes
+
+- fix shared-types TS errors ([7b83164](https://github.com/instructure/instructure-ui/commit/7b83164f4c5872f3a217e010563f59bf584ae4fc))
+
 # [8.8.0](https://github.com/instructure/instructure-ui/compare/v8.7.0...v8.8.0) (2021-08-27)
 
 **Note:** Version bump only for package @instructure/ui-dialog

package/es/Dialog/index.js

@@ -25,11 +25,11 @@ const _excluded = ["open", "contentElement"];
  * SOFTWARE.
  */
 import React, { Component } from 'react';
-import PropTypes from 'prop-types';
 import { omitProps, getElementType } from '@instructure/ui-react-utils';
 import { findDOMNode, requestAnimationFrame } from '@instructure/ui-dom-utils';
 import { logError as error } from '@instructure/console';
 import { FocusRegionManager } from '@instructure/ui-a11y-utils';
+import { propTypes, allowedProps } from './props';
 
 /**
 ---
@@ -157,57 +157,10 @@ class Dialog extends Component {
 
 Dialog.displayName = "Dialog";
 Dialog.componentId = 'Dialog';
-Dialog.propTypes = {
-  /**
-   * The children to be rendered within the `<Dialog />`
-   */
-  children: PropTypes.node,
-
-  /**
-   * The element to render as the component root, `span` by default
-   */
-  as: PropTypes.elementType,
-  // eslint-disable-line react/require-default-props
-  display: PropTypes.oneOf(['auto', 'block', 'inline-block']),
-  label: PropTypes.string,
-
-  /**
-   * Whether or not the `<Dialog />` is open
-   */
-  open: PropTypes.bool,
-
-  /**
-   * Function called when tab focus leaves the `<Dialog />` focusable content. This only
-   * occurs when `shouldContainFocus` is set to false.
-   */
-  onBlur: PropTypes.func,
-  onDismiss: PropTypes.func,
-
-  /**
-   * An element or a function returning an element to focus by default
-   */
-  defaultFocusElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
-
-  /**
-   * An element or a function returning an element that wraps the content of the `<Dialog />`
-   */
-  contentElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
-
-  /**
-   * An element, function returning an element, or array of elements that will not be hidden from
-   * the screen reader when the `<Dialog />` is open
-   */
-  liveRegion: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.element), PropTypes.element, PropTypes.func]),
-  shouldContainFocus: PropTypes.oneOfType([PropTypes.bool, PropTypes.oneOf(['keyboard', 'screenreader'])]),
-  shouldReturnFocus: PropTypes.bool,
-  shouldCloseOnDocumentClick: PropTypes.bool,
-  shouldCloseOnEscape: PropTypes.bool,
-  shouldFocusOnOpen: PropTypes.bool
-};
+Dialog.propTypes = propTypes;
+Dialog.allowedProps = allowedProps;
 Dialog.defaultProps = {
   children: null,
-  display: void 0,
-  label: void 0,
   open: false,
   shouldFocusOnOpen: true,
   shouldContainFocus: false,

package/es/Dialog/props.js

@@ -0,0 +1,73 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present 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.
+ */
+import PropTypes from 'prop-types';
+const propTypes = {
+  /**
+   * The children to be rendered within the `<Dialog />`
+   */
+  children: PropTypes.node,
+
+  /**
+   * The element to render as the component root, `span` by default
+   */
+  as: PropTypes.elementType,
+  // eslint-disable-line react/require-default-props
+  display: PropTypes.oneOf(['auto', 'block', 'inline-block']),
+  label: PropTypes.string,
+
+  /**
+   * Whether or not the `<Dialog />` is open
+   */
+  open: PropTypes.bool,
+
+  /**
+   * Function called when tab focus leaves the `<Dialog />` focusable content. This only
+   * occurs when `shouldContainFocus` is set to false.
+   */
+  onBlur: PropTypes.func,
+  onDismiss: PropTypes.func,
+
+  /**
+   * An element or a function returning an element to focus by default
+   */
+  defaultFocusElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
+
+  /**
+   * An element or a function returning an element that wraps the content of the `<Dialog />`
+   */
+  contentElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
+
+  /**
+   * An element, function returning an element, or array of elements that will not be hidden from
+   * the screen reader when the `<Dialog />` is open
+   */
+  liveRegion: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.element), PropTypes.element, PropTypes.func]),
+  shouldContainFocus: PropTypes.oneOfType([PropTypes.bool, PropTypes.oneOf(['keyboard', 'screenreader'])]),
+  shouldReturnFocus: PropTypes.bool,
+  shouldCloseOnDocumentClick: PropTypes.bool,
+  shouldCloseOnEscape: PropTypes.bool,
+  shouldFocusOnOpen: PropTypes.bool
+};
+const allowedProps = ['children', 'as', 'display', 'label', 'open', 'onBlur', 'onDismiss', 'defaultFocusElement', 'contentElement', 'liveRegion', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'shouldFocusOnOpen'];
+export { propTypes, allowedProps };

package/lib/Dialog/index.js

@@ -13,8 +13,6 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
 
 var _react = _interopRequireWildcard(require("react"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _omitProps = require("@instructure/ui-react-utils/lib/omitProps.js");
 
 var _getElementType = require("@instructure/ui-react-utils/lib/getElementType.js");
@@ -27,6 +25,8 @@ var _console = require("@instructure/console");
 
 var _FocusRegionManager = require("@instructure/ui-a11y-utils/lib/FocusRegionManager.js");
 
+var _props = require("./props");
+
 const _excluded = ["open", "contentElement"];
 
 /**
@@ -156,57 +156,10 @@ class Dialog extends _react.Component {
 exports.Dialog = Dialog;
 Dialog.displayName = "Dialog";
 Dialog.componentId = 'Dialog';
-Dialog.propTypes = {
-  /**
-   * The children to be rendered within the `<Dialog />`
-   */
-  children: _propTypes.default.node,
-
-  /**
-   * The element to render as the component root, `span` by default
-   */
-  as: _propTypes.default.elementType,
-  // eslint-disable-line react/require-default-props
-  display: _propTypes.default.oneOf(['auto', 'block', 'inline-block']),
-  label: _propTypes.default.string,
-
-  /**
-   * Whether or not the `<Dialog />` is open
-   */
-  open: _propTypes.default.bool,
-
-  /**
-   * Function called when tab focus leaves the `<Dialog />` focusable content. This only
-   * occurs when `shouldContainFocus` is set to false.
-   */
-  onBlur: _propTypes.default.func,
-  onDismiss: _propTypes.default.func,
-
-  /**
-   * An element or a function returning an element to focus by default
-   */
-  defaultFocusElement: _propTypes.default.oneOfType([_propTypes.default.element, _propTypes.default.func]),
-
-  /**
-   * An element or a function returning an element that wraps the content of the `<Dialog />`
-   */
-  contentElement: _propTypes.default.oneOfType([_propTypes.default.element, _propTypes.default.func]),
-
-  /**
-   * An element, function returning an element, or array of elements that will not be hidden from
-   * the screen reader when the `<Dialog />` is open
-   */
-  liveRegion: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.element), _propTypes.default.element, _propTypes.default.func]),
-  shouldContainFocus: _propTypes.default.oneOfType([_propTypes.default.bool, _propTypes.default.oneOf(['keyboard', 'screenreader'])]),
-  shouldReturnFocus: _propTypes.default.bool,
-  shouldCloseOnDocumentClick: _propTypes.default.bool,
-  shouldCloseOnEscape: _propTypes.default.bool,
-  shouldFocusOnOpen: _propTypes.default.bool
-};
+Dialog.propTypes = _props.propTypes;
+Dialog.allowedProps = _props.allowedProps;
 Dialog.defaultProps = {
   children: null,
-  display: void 0,
-  label: void 0,
   open: false,
   shouldFocusOnOpen: true,
   shouldContainFocus: false,

package/lib/Dialog/props.js

@@ -0,0 +1,84 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.allowedProps = exports.propTypes = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present 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.
+ */
+const propTypes = {
+  /**
+   * The children to be rendered within the `<Dialog />`
+   */
+  children: _propTypes.default.node,
+
+  /**
+   * The element to render as the component root, `span` by default
+   */
+  as: _propTypes.default.elementType,
+  // eslint-disable-line react/require-default-props
+  display: _propTypes.default.oneOf(['auto', 'block', 'inline-block']),
+  label: _propTypes.default.string,
+
+  /**
+   * Whether or not the `<Dialog />` is open
+   */
+  open: _propTypes.default.bool,
+
+  /**
+   * Function called when tab focus leaves the `<Dialog />` focusable content. This only
+   * occurs when `shouldContainFocus` is set to false.
+   */
+  onBlur: _propTypes.default.func,
+  onDismiss: _propTypes.default.func,
+
+  /**
+   * An element or a function returning an element to focus by default
+   */
+  defaultFocusElement: _propTypes.default.oneOfType([_propTypes.default.element, _propTypes.default.func]),
+
+  /**
+   * An element or a function returning an element that wraps the content of the `<Dialog />`
+   */
+  contentElement: _propTypes.default.oneOfType([_propTypes.default.element, _propTypes.default.func]),
+
+  /**
+   * An element, function returning an element, or array of elements that will not be hidden from
+   * the screen reader when the `<Dialog />` is open
+   */
+  liveRegion: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.element), _propTypes.default.element, _propTypes.default.func]),
+  shouldContainFocus: _propTypes.default.oneOfType([_propTypes.default.bool, _propTypes.default.oneOf(['keyboard', 'screenreader'])]),
+  shouldReturnFocus: _propTypes.default.bool,
+  shouldCloseOnDocumentClick: _propTypes.default.bool,
+  shouldCloseOnEscape: _propTypes.default.bool,
+  shouldFocusOnOpen: _propTypes.default.bool
+};
+exports.propTypes = propTypes;
+const allowedProps = ['children', 'as', 'display', 'label', 'open', 'onBlur', 'onDismiss', 'defaultFocusElement', 'contentElement', 'liveRegion', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'shouldFocusOnOpen'];
+exports.allowedProps = allowedProps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-dialog",
-  "version": "8.8.1-snapshot.7+90b251d58",
+  "version": "8.9.1-snapshot.2+7f5faa3df",
   "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/ui-a11y-utils": "8.8.1-snapshot.7+90b251d58",
-    "@instructure/ui-dom-utils": "8.8.1-snapshot.7+90b251d58",
-    "@instructure/ui-react-utils": "8.8.1-snapshot.7+90b251d58",
-    "@instructure/ui-testable": "8.8.1-snapshot.7+90b251d58",
+    "@instructure/shared-types": "8.9.1-snapshot.2+7f5faa3df",
+    "@instructure/ui-a11y-utils": "8.9.1-snapshot.2+7f5faa3df",
+    "@instructure/ui-dom-utils": "8.9.1-snapshot.2+7f5faa3df",
+    "@instructure/ui-react-utils": "8.9.1-snapshot.2+7f5faa3df",
+    "@instructure/ui-testable": "8.9.1-snapshot.2+7f5faa3df",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/console": "8.8.1-snapshot.7+90b251d58",
-    "@instructure/shared-types": "8.8.1-snapshot.7+90b251d58",
-    "@instructure/ui-babel-preset": "8.8.1-snapshot.7+90b251d58",
-    "@instructure/ui-prop-types": "8.8.1-snapshot.7+90b251d58",
-    "@instructure/ui-test-utils": "8.8.1-snapshot.7+90b251d58"
+    "@instructure/console": "8.9.1-snapshot.2+7f5faa3df",
+    "@instructure/ui-babel-preset": "8.9.1-snapshot.2+7f5faa3df",
+    "@instructure/ui-prop-types": "8.9.1-snapshot.2+7f5faa3df",
+    "@instructure/ui-test-utils": "8.9.1-snapshot.2+7f5faa3df"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -45,5 +45,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "90b251d580c75205b6cbb884fe922059cfc494dd"
+  "gitHead": "7f5faa3df83667636304e0901ef1008d98dffc9a"
 }

package/src/Dialog/index.tsx

@@ -23,7 +23,6 @@
  */
 
 import React, { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { omitProps, getElementType } from '@instructure/ui-react-utils'
 import { findDOMNode, requestAnimationFrame } from '@instructure/ui-dom-utils'
@@ -32,7 +31,8 @@ import { logError as error } from '@instructure/console'
 import type { OtherHTMLAttributes } from '@instructure/shared-types'
 import { FocusRegionManager } from '@instructure/ui-a11y-utils'
 
-import { DialogProps } from './types'
+import { propTypes, allowedProps } from './props'
+import type { DialogProps } from './props'
 
 /**
 ---
@@ -44,70 +44,10 @@ category: components/utilities
 class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogProps>> {
   static readonly componentId = 'Dialog'
 
-  static propTypes = {
-    /**
-     * The children to be rendered within the `<Dialog />`
-     */
-    children: PropTypes.node,
-
-    /**
-     * The element to render as the component root, `span` by default
-     */
-    as: PropTypes.elementType, // eslint-disable-line react/require-default-props
-
-    display: PropTypes.oneOf(['auto', 'block', 'inline-block']),
-
-    label: PropTypes.string,
-
-    /**
-     * Whether or not the `<Dialog />` is open
-     */
-    open: PropTypes.bool,
-
-    /**
-     * Function called when tab focus leaves the `<Dialog />` focusable content. This only
-     * occurs when `shouldContainFocus` is set to false.
-     */
-    onBlur: PropTypes.func,
-
-    onDismiss: PropTypes.func,
-
-    /**
-     * An element or a function returning an element to focus by default
-     */
-    defaultFocusElement: PropTypes.oneOfType([
-      PropTypes.element,
-      PropTypes.func
-    ]),
-
-    /**
-     * An element or a function returning an element that wraps the content of the `<Dialog />`
-     */
-    contentElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
-
-    /**
-     * An element, function returning an element, or array of elements that will not be hidden from
-     * the screen reader when the `<Dialog />` is open
-     */
-    liveRegion: PropTypes.oneOfType([
-      PropTypes.arrayOf(PropTypes.element),
-      PropTypes.element,
-      PropTypes.func
-    ]),
-    shouldContainFocus: PropTypes.oneOfType([
-      PropTypes.bool,
-      PropTypes.oneOf(['keyboard', 'screenreader'])
-    ]),
-    shouldReturnFocus: PropTypes.bool,
-    shouldCloseOnDocumentClick: PropTypes.bool,
-    shouldCloseOnEscape: PropTypes.bool,
-    shouldFocusOnOpen: PropTypes.bool
-  } as const
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     children: null,
-    display: undefined,
-    label: undefined,
     open: false,
     shouldFocusOnOpen: true,
     shouldContainFocus: false,
@@ -243,7 +183,7 @@ class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogProps>> {
 
     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)"
+        // @ts-expect-error TODO: `ref` prop causes: "Expression produces a union type that is too complex to represent.ts(2590)"
         {...omitProps(this.props, Dialog.propTypes)}
         role={this.props.label ? 'dialog' : undefined}
         aria-label={this.props.label}

package/src/Dialog/props.ts

@@ -0,0 +1,133 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present 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.
+ */
+
+import React from 'react'
+import PropTypes from 'prop-types'
+
+import type { AsElementType, PropValidators } from '@instructure/shared-types'
+
+type DialogOwnProps = {
+  children?: React.ReactNode
+  as?: AsElementType
+  display?: 'auto' | 'block' | 'inline-block'
+  label?: string
+  open?: boolean
+  onBlur?: (...args: any[]) => any
+  onDismiss?: (...args: any[]) => any
+  defaultFocusElement?: React.ReactElement | ((...args: any[]) => any)
+  contentElement?: React.ReactElement | ((...args: any[]) => any)
+  liveRegion?:
+    | React.ReactElement[]
+    | React.ReactElement
+    | ((...args: any[]) => any)
+  shouldContainFocus?: boolean | ('keyboard' | 'screenreader')
+  shouldReturnFocus?: boolean
+  shouldCloseOnDocumentClick?: boolean
+  shouldCloseOnEscape?: boolean
+  shouldFocusOnOpen?: boolean
+}
+
+type PropKeys = keyof DialogOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type DialogProps = DialogOwnProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * The children to be rendered within the `<Dialog />`
+   */
+  children: PropTypes.node,
+
+  /**
+   * The element to render as the component root, `span` by default
+   */
+  as: PropTypes.elementType, // eslint-disable-line react/require-default-props
+
+  display: PropTypes.oneOf(['auto', 'block', 'inline-block']),
+
+  label: PropTypes.string,
+
+  /**
+   * Whether or not the `<Dialog />` is open
+   */
+  open: PropTypes.bool,
+
+  /**
+   * Function called when tab focus leaves the `<Dialog />` focusable content. This only
+   * occurs when `shouldContainFocus` is set to false.
+   */
+  onBlur: PropTypes.func,
+
+  onDismiss: PropTypes.func,
+
+  /**
+   * An element or a function returning an element to focus by default
+   */
+  defaultFocusElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
+
+  /**
+   * An element or a function returning an element that wraps the content of the `<Dialog />`
+   */
+  contentElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
+
+  /**
+   * An element, function returning an element, or array of elements that will not be hidden from
+   * the screen reader when the `<Dialog />` is open
+   */
+  liveRegion: PropTypes.oneOfType([
+    PropTypes.arrayOf(PropTypes.element),
+    PropTypes.element,
+    PropTypes.func
+  ]),
+  shouldContainFocus: PropTypes.oneOfType([
+    PropTypes.bool,
+    PropTypes.oneOf(['keyboard', 'screenreader'])
+  ]),
+  shouldReturnFocus: PropTypes.bool,
+  shouldCloseOnDocumentClick: PropTypes.bool,
+  shouldCloseOnEscape: PropTypes.bool,
+  shouldFocusOnOpen: PropTypes.bool
+}
+
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'as',
+  'display',
+  'label',
+  'open',
+  'onBlur',
+  'onDismiss',
+  'defaultFocusElement',
+  'contentElement',
+  'liveRegion',
+  'shouldContainFocus',
+  'shouldReturnFocus',
+  'shouldCloseOnDocumentClick',
+  'shouldCloseOnEscape',
+  'shouldFocusOnOpen'
+]
+
+export type { DialogProps }
+export { propTypes, allowedProps }

package/src/index.ts

@@ -22,4 +22,4 @@
  * SOFTWARE.
  */
 export { Dialog } from './Dialog'
-export type { DialogProps } from './Dialog/types'
+export type { DialogProps } from './Dialog/props'

package/types/Dialog/index.d.ts

@@ -1,8 +1,7 @@
-import { Component } from 'react';
-import PropTypes from 'prop-types';
+import React, { Component } from 'react';
 import type { RequestAnimationFrameType } from '@instructure/ui-dom-utils';
 import type { OtherHTMLAttributes } from '@instructure/shared-types';
-import { DialogProps } from './types';
+import type { DialogProps } from './props';
 /**
 ---
 category: components/utilities
@@ -11,50 +10,42 @@ category: components/utilities
 **/
 declare class Dialog extends Component<DialogProps & OtherHTMLAttributes<DialogProps>> {
     static readonly componentId = "Dialog";
-    static propTypes: {
-        /**
-         * The children to be rendered within the `<Dialog />`
-         */
-        readonly children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        /**
-         * The element to render as the component root, `span` by default
-         */
-        readonly as: PropTypes.Requireable<PropTypes.ReactComponentLike>;
-        readonly display: PropTypes.Requireable<string>;
-        readonly label: PropTypes.Requireable<string>;
-        /**
-         * Whether or not the `<Dialog />` is open
-         */
-        readonly open: PropTypes.Requireable<boolean>;
-        /**
-         * Function called when tab focus leaves the `<Dialog />` focusable content. This only
-         * occurs when `shouldContainFocus` is set to false.
-         */
-        readonly onBlur: PropTypes.Requireable<(...args: any[]) => any>;
-        readonly onDismiss: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * An element or a function returning an element to focus by default
-         */
-        readonly defaultFocusElement: PropTypes.Requireable<PropTypes.ReactElementLike | ((...args: any[]) => any)>;
-        /**
-         * An element or a function returning an element that wraps the content of the `<Dialog />`
-         */
-        readonly contentElement: PropTypes.Requireable<PropTypes.ReactElementLike | ((...args: any[]) => any)>;
-        /**
-         * An element, function returning an element, or array of elements that will not be hidden from
-         * the screen reader when the `<Dialog />` is open
-         */
-        readonly liveRegion: PropTypes.Requireable<PropTypes.ReactElementLike | ((...args: any[]) => any) | (PropTypes.ReactElementLike | null | undefined)[]>;
-        readonly shouldContainFocus: PropTypes.Requireable<string | boolean>;
-        readonly shouldReturnFocus: PropTypes.Requireable<boolean>;
-        readonly shouldCloseOnDocumentClick: PropTypes.Requireable<boolean>;
-        readonly shouldCloseOnEscape: PropTypes.Requireable<boolean>;
-        readonly shouldFocusOnOpen: PropTypes.Requireable<boolean>;
-    };
+    static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
+        children?: React.ReactNode;
+        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
+        display?: "auto" | "block" | "inline-block" | undefined;
+        label?: string | undefined;
+        open?: boolean | undefined;
+        onBlur?: ((...args: any[]) => any) | undefined;
+        onDismiss?: ((...args: any[]) => any) | undefined;
+        defaultFocusElement?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
+        contentElement?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
+        liveRegion?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | React.ReactElement<any, string | React.JSXElementConstructor<any>>[] | ((...args: any[]) => any) | undefined;
+        shouldContainFocus?: boolean | "keyboard" | "screenreader" | undefined;
+        shouldReturnFocus?: boolean | undefined;
+        shouldCloseOnDocumentClick?: boolean | undefined;
+        shouldCloseOnEscape?: boolean | undefined;
+        shouldFocusOnOpen?: boolean | undefined;
+    }>;
+    static allowedProps: readonly (keyof {
+        children?: React.ReactNode;
+        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
+        display?: "auto" | "block" | "inline-block" | undefined;
+        label?: string | undefined;
+        open?: boolean | undefined;
+        onBlur?: ((...args: any[]) => any) | undefined;
+        onDismiss?: ((...args: any[]) => any) | undefined;
+        defaultFocusElement?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
+        contentElement?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
+        liveRegion?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | React.ReactElement<any, string | React.JSXElementConstructor<any>>[] | ((...args: any[]) => any) | undefined;
+        shouldContainFocus?: boolean | "keyboard" | "screenreader" | undefined;
+        shouldReturnFocus?: boolean | undefined;
+        shouldCloseOnDocumentClick?: boolean | undefined;
+        shouldCloseOnEscape?: boolean | undefined;
+        shouldFocusOnOpen?: boolean | undefined;
+    })[];
     static defaultProps: {
         readonly children: null;
-        readonly display: undefined;
-        readonly label: undefined;
         readonly open: false;
         readonly shouldFocusOnOpen: true;
         readonly shouldContainFocus: false;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Dialog/index.tsx"],"names":[],"mappings":"AAwBA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACxC,OAAO,SAAS,MAAM,YAAY,CAAA;AAIlC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAE1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAGpE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC;;;;;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;QACd;;WAEG;;QAGH;;WAEG;;;;QAOH;;WAEG;;QAGH;;;WAGG;;;QAKH;;WAEG;;QAMH;;WAEG;;QAGH;;;WAGG;;;;;;;MAcK;IAEV,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;MAiBT;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,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"}

package/types/Dialog/{types.d.ts → props.d.ts}

@@ -1,6 +1,7 @@
-import type { ReactNode } from 'react';
-import { AsElementType } from '@instructure/shared-types';
-export declare type DialogProps = {
+import React from 'react';
+import type { AsElementType, PropValidators } from '@instructure/shared-types';
+declare type DialogOwnProps = {
+    children?: React.ReactNode;
     as?: AsElementType;
     display?: 'auto' | 'block' | 'inline-block';
     label?: string;
@@ -15,6 +16,12 @@ export declare type DialogProps = {
     shouldCloseOnDocumentClick?: boolean;
     shouldCloseOnEscape?: boolean;
     shouldFocusOnOpen?: boolean;
-    children?: ReactNode;
 };
-//# sourceMappingURL=types.d.ts.map
+declare type PropKeys = keyof DialogOwnProps;
+declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
+declare type DialogProps = DialogOwnProps;
+declare const propTypes: PropValidators<PropKeys>;
+declare const allowedProps: AllowedPropKeys;
+export type { DialogProps };
+export { propTypes, allowedProps };
+//# sourceMappingURL=props.d.ts.map

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

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

package/types/index.d.ts

@@ -1,3 +1,3 @@
 export { Dialog } from './Dialog';
-export type { DialogProps } from './Dialog/types';
+export type { DialogProps } from './Dialog/props';
 //# sourceMappingURL=index.d.ts.map

package/es/Dialog/types.js

@@ -1 +0,0 @@
-export {};

package/lib/Dialog/types.js

@@ -1 +0,0 @@
-"use strict";

package/src/Dialog/types.ts

@@ -1,47 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present 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.
- */
-
-import type { ReactNode } from 'react'
-import { AsElementType } from '@instructure/shared-types'
-
-export type DialogProps = {
-  as?: AsElementType
-  display?: 'auto' | 'block' | 'inline-block'
-  label?: string
-  open?: boolean
-  onBlur?: (...args: any[]) => any
-  onDismiss?: (...args: any[]) => any
-  defaultFocusElement?: React.ReactElement | ((...args: any[]) => any)
-  contentElement?: React.ReactElement | ((...args: any[]) => any)
-  liveRegion?:
-    | React.ReactElement[]
-    | React.ReactElement
-    | ((...args: any[]) => any)
-  shouldContainFocus?: boolean | ('keyboard' | 'screenreader')
-  shouldReturnFocus?: boolean
-  shouldCloseOnDocumentClick?: boolean
-  shouldCloseOnEscape?: boolean
-  shouldFocusOnOpen?: boolean
-  children?: ReactNode
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/Dialog/types.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD,oBAAY,WAAW,GAAG;IACxB,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,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB,CAAA"}