@instructure/ui-overlays 8.56.0 → 9.0.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [9.0.0](https://github.com/instructure/instructure-ui/compare/v8.56.0...v9.0.0) (2024-05-09)
+
+
+### Features
+
+* **ui-overlays:** remove deprecated props from Mask and Overlay ([e079b81](https://github.com/instructure/instructure-ui/commit/e079b81859dc9dfe69e16ba65a1e1f5c24740640))
+
+
+### BREAKING CHANGES
+
+* **ui-overlays:** removed onDismiss prop from Mask and applicationElement from Overlay
+
+
+
+
+
 # [8.56.0](https://github.com/instructure/instructure-ui/compare/v8.55.1...v8.56.0) (2024-05-06)
 
 **Note:** Version bump only for package @instructure/ui-overlays

package/es/Mask/index.js

@@ -1,4 +1,4 @@
-var _dec, _dec2, _class, _class2;
+var _dec, _class, _class2;
 /*
  * The MIT License (MIT)
  *
@@ -27,7 +27,7 @@ var _dec, _dec2, _class, _class2;
 import React, { Component } from 'react';
 import noScroll from 'no-scroll';
 import { withStyle, jsx } from '@instructure/emotion';
-import { ensureSingleChild, omitProps, deprecated } from '@instructure/ui-react-utils';
+import { ensureSingleChild, omitProps } from '@instructure/ui-react-utils';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
 import { allowedProps, propTypes } from './props';
@@ -38,9 +38,7 @@ import MaskCounter from './MaskCounter';
 category: components/utilities
 ---
 **/
-let Mask = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = deprecated('9.0.0', {
-  onDismiss: null
-}), _dec(_class = _dec2(_class = (_class2 = class Mask extends Component {
+let Mask = (_dec = withStyle(generateStyle, generateComponentTheme), _dec(_class = (_class2 = class Mask extends Component {
   constructor(...args) {
     super(...args);
     this.ref = null;
@@ -96,6 +94,6 @@ let Mask = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = dep
 }, _class2.displayName = "Mask", _class2.componentId = 'Mask', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
   placement: 'center',
   fullscreen: false
-}, _class2)) || _class) || _class);
+}, _class2)) || _class);
 export default Mask;
 export { Mask };

package/es/Mask/props.js

@@ -28,11 +28,7 @@ const propTypes = {
   fullscreen: PropTypes.bool,
   children: PropTypes.node,
   onClick: PropTypes.func,
-  elementRef: PropTypes.func,
-  onDismiss: PropTypes.func // TODO: deprecated, remove in V9
+  elementRef: PropTypes.func
 };
-
-const allowedProps = ['placement', 'fullscreen', 'children', 'onClick', 'elementRef',
-// TODO: deprecated, remove in V9
-'onDismiss'];
+const allowedProps = ['placement', 'fullscreen', 'children', 'onClick', 'elementRef'];
 export { propTypes, allowedProps };

package/es/Overlay/index.js

@@ -1,4 +1,4 @@
-var _dec, _dec2, _class, _class2;
+var _dec, _class, _class2;
 /*
  * The MIT License (MIT)
  *
@@ -26,7 +26,7 @@ var _dec, _dec2, _class, _class2;
 import React, { Component } from 'react';
 import { testable } from '@instructure/ui-testable';
 import { createChainedFunction } from '@instructure/ui-utils';
-import { omitProps, pickProps, deprecated } from '@instructure/ui-react-utils';
+import { omitProps, pickProps } from '@instructure/ui-react-utils';
 import { Dialog } from '@instructure/ui-dialog';
 import { Portal } from '@instructure/ui-portal';
 import { Transition } from '@instructure/ui-motion';
@@ -37,9 +37,7 @@ import { allowedProps, propTypes } from './props';
 category: components
 ---
 **/
-let Overlay = (_dec = testable(), _dec2 = deprecated('9.0.0', {
-  applicationElement: null
-}), _dec(_class = _dec2(_class = (_class2 = class Overlay extends Component {
+let Overlay = (_dec = testable(), _dec(_class = (_class2 = class Overlay extends Component {
   constructor(props) {
     super(props);
     this._timeouts = [];
@@ -126,6 +124,6 @@ let Overlay = (_dec = testable(), _dec2 = deprecated('9.0.0', {
   transitionOnMount: false,
   transitionEnter: true,
   transitionExit: true
-}, _class2)) || _class) || _class);
+}, _class2)) || _class);
 export default Overlay;
 export { Overlay };

package/es/Overlay/props.js

@@ -51,11 +51,7 @@ const propTypes = {
   onEntered: PropTypes.func,
   onExit: PropTypes.func,
   onExiting: PropTypes.func,
-  onExited: PropTypes.func,
-  // TODO: deprecated, remove in V9
-  applicationElement: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.element), PropTypes.element, PropTypes.func])
+  onExited: PropTypes.func
 };
-const allowedProps = ['children', 'open', 'onOpen', 'onClose', 'mountNode', 'insertAt', 'label', 'onDismiss', 'defaultFocusElement', 'contentElement', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'transition', 'in', 'unmountOnExit', 'transitionOnMount', 'transitionEnter', 'transitionExit', 'onEnter', 'onEntering', 'onEntered', 'onExit', 'onExiting', 'onExited',
-// TODO: deprecated, remove in V9
-'applicationElement'];
+const allowedProps = ['children', 'open', 'onOpen', 'onClose', 'mountNode', 'insertAt', 'label', 'onDismiss', 'defaultFocusElement', 'contentElement', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'transition', 'in', 'unmountOnExit', 'transitionOnMount', 'transitionEnter', 'transitionExit', 'onEnter', 'onEntering', 'onEntered', 'onExit', 'onExiting', 'onExited'];
 export { propTypes, allowedProps };

package/lib/Mask/index.js

@@ -11,12 +11,11 @@ var _noScroll = _interopRequireDefault(require("no-scroll"));
 var _emotion = require("@instructure/emotion");
 var _ensureSingleChild = require("@instructure/ui-react-utils/lib/ensureSingleChild.js");
 var _omitProps = require("@instructure/ui-react-utils/lib/omitProps.js");
-var _deprecated = require("@instructure/ui-react-utils/lib/deprecated.js");
 var _styles = _interopRequireDefault(require("./styles"));
 var _theme = _interopRequireDefault(require("./theme"));
 var _props = require("./props");
 var _MaskCounter = _interopRequireDefault(require("./MaskCounter"));
-var _dec, _dec2, _class, _class2;
+var _dec, _class, _class2;
 /*
  * The MIT License (MIT)
  *
@@ -46,9 +45,7 @@ var _dec, _dec2, _class, _class2;
 category: components/utilities
 ---
 **/
-let Mask = exports.Mask = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _dec2 = (0, _deprecated.deprecated)('9.0.0', {
-  onDismiss: null
-}), _dec(_class = _dec2(_class = (_class2 = class Mask extends _react.Component {
+let Mask = exports.Mask = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _dec(_class = (_class2 = class Mask extends _react.Component {
   constructor(...args) {
     super(...args);
     this.ref = null;
@@ -104,5 +101,5 @@ let Mask = exports.Mask = (_dec = (0, _emotion.withStyle)(_styles.default, _them
 }, _class2.displayName = "Mask", _class2.componentId = 'Mask', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   placement: 'center',
   fullscreen: false
-}, _class2)) || _class) || _class);
+}, _class2)) || _class);
 var _default = exports.default = Mask;

package/lib/Mask/props.js

@@ -35,10 +35,6 @@ const propTypes = exports.propTypes = {
   fullscreen: _propTypes.default.bool,
   children: _propTypes.default.node,
   onClick: _propTypes.default.func,
-  elementRef: _propTypes.default.func,
-  onDismiss: _propTypes.default.func // TODO: deprecated, remove in V9
+  elementRef: _propTypes.default.func
 };
-
-const allowedProps = exports.allowedProps = ['placement', 'fullscreen', 'children', 'onClick', 'elementRef',
-// TODO: deprecated, remove in V9
-'onDismiss'];
+const allowedProps = exports.allowedProps = ['placement', 'fullscreen', 'children', 'onClick', 'elementRef'];

package/lib/Overlay/index.js

@@ -10,12 +10,11 @@ var _testable = require("@instructure/ui-testable/lib/testable.js");
 var _createChainedFunction = require("@instructure/ui-utils/lib/createChainedFunction.js");
 var _omitProps = require("@instructure/ui-react-utils/lib/omitProps.js");
 var _pickProps = require("@instructure/ui-react-utils/lib/pickProps.js");
-var _deprecated = require("@instructure/ui-react-utils/lib/deprecated.js");
 var _Dialog = require("@instructure/ui-dialog/lib/Dialog");
 var _Portal = require("@instructure/ui-portal/lib/Portal");
 var _Transition = require("@instructure/ui-motion/lib/Transition");
 var _props = require("./props");
-var _dec, _dec2, _class, _class2;
+var _dec, _class, _class2;
 /*
  * The MIT License (MIT)
  *
@@ -44,9 +43,7 @@ var _dec, _dec2, _class, _class2;
 category: components
 ---
 **/
-let Overlay = exports.Overlay = (_dec = (0, _testable.testable)(), _dec2 = (0, _deprecated.deprecated)('9.0.0', {
-  applicationElement: null
-}), _dec(_class = _dec2(_class = (_class2 = class Overlay extends _react.Component {
+let Overlay = exports.Overlay = (_dec = (0, _testable.testable)(), _dec(_class = (_class2 = class Overlay extends _react.Component {
   constructor(props) {
     super(props);
     this._timeouts = [];
@@ -133,5 +130,5 @@ let Overlay = exports.Overlay = (_dec = (0, _testable.testable)(), _dec2 = (0, _
   transitionOnMount: false,
   transitionEnter: true,
   transitionExit: true
-}, _class2)) || _class) || _class);
+}, _class2)) || _class);
 var _default = exports.default = Overlay;

package/lib/Overlay/props.js

@@ -58,10 +58,6 @@ const propTypes = exports.propTypes = {
   onEntered: _propTypes.default.func,
   onExit: _propTypes.default.func,
   onExiting: _propTypes.default.func,
-  onExited: _propTypes.default.func,
-  // TODO: deprecated, remove in V9
-  applicationElement: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.element), _propTypes.default.element, _propTypes.default.func])
+  onExited: _propTypes.default.func
 };
-const allowedProps = exports.allowedProps = ['children', 'open', 'onOpen', 'onClose', 'mountNode', 'insertAt', 'label', 'onDismiss', 'defaultFocusElement', 'contentElement', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'transition', 'in', 'unmountOnExit', 'transitionOnMount', 'transitionEnter', 'transitionExit', 'onEnter', 'onEntering', 'onEntered', 'onExit', 'onExiting', 'onExited',
-// TODO: deprecated, remove in V9
-'applicationElement'];
+const allowedProps = exports.allowedProps = ['children', 'open', 'onOpen', 'onClose', 'mountNode', 'insertAt', 'label', 'onDismiss', 'defaultFocusElement', 'contentElement', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'transition', 'in', 'unmountOnExit', 'transitionOnMount', 'transitionEnter', 'transitionExit', 'onEnter', 'onEntering', 'onEntered', 'onExit', 'onExiting', 'onExited'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-overlays",
-  "version": "8.56.0",
+  "version": "9.0.0",
   "description": "A UI component library made by Instructure Inc.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -23,8 +23,8 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.56.0",
-    "@instructure/ui-themes": "8.56.0",
+    "@instructure/ui-babel-preset": "9.0.0",
+    "@instructure/ui-themes": "9.0.0",
     "@testing-library/jest-dom": "^6.1.4",
     "@testing-library/react": "^14.1.2",
     "@testing-library/user-event": "^14.5.1",
@@ -32,25 +32,25 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.23.2",
-    "@instructure/console": "8.56.0",
-    "@instructure/emotion": "8.56.0",
-    "@instructure/shared-types": "8.56.0",
-    "@instructure/ui-buttons": "8.56.0",
-    "@instructure/ui-dialog": "8.56.0",
-    "@instructure/ui-dom-utils": "8.56.0",
-    "@instructure/ui-focusable": "8.56.0",
-    "@instructure/ui-i18n": "8.56.0",
-    "@instructure/ui-motion": "8.56.0",
-    "@instructure/ui-popover": "8.56.0",
-    "@instructure/ui-portal": "8.56.0",
-    "@instructure/ui-position": "8.56.0",
-    "@instructure/ui-prop-types": "8.56.0",
-    "@instructure/ui-react-utils": "8.56.0",
-    "@instructure/ui-testable": "8.56.0",
-    "@instructure/ui-tooltip": "8.56.0",
-    "@instructure/ui-utils": "8.56.0",
-    "@instructure/ui-view": "8.56.0",
-    "@instructure/uid": "8.56.0",
+    "@instructure/console": "9.0.0",
+    "@instructure/emotion": "9.0.0",
+    "@instructure/shared-types": "9.0.0",
+    "@instructure/ui-buttons": "9.0.0",
+    "@instructure/ui-dialog": "9.0.0",
+    "@instructure/ui-dom-utils": "9.0.0",
+    "@instructure/ui-focusable": "9.0.0",
+    "@instructure/ui-i18n": "9.0.0",
+    "@instructure/ui-motion": "9.0.0",
+    "@instructure/ui-popover": "9.0.0",
+    "@instructure/ui-portal": "9.0.0",
+    "@instructure/ui-position": "9.0.0",
+    "@instructure/ui-prop-types": "9.0.0",
+    "@instructure/ui-react-utils": "9.0.0",
+    "@instructure/ui-testable": "9.0.0",
+    "@instructure/ui-tooltip": "9.0.0",
+    "@instructure/ui-utils": "9.0.0",
+    "@instructure/ui-view": "9.0.0",
+    "@instructure/uid": "9.0.0",
     "no-scroll": "^2.1.1",
     "prop-types": "^15.8.1"
   },

package/src/Mask/index.tsx

@@ -28,11 +28,7 @@ import noScroll from 'no-scroll'
 
 import { withStyle, jsx } from '@instructure/emotion'
 import type { ComponentStyle } from '@instructure/emotion'
-import {
-  ensureSingleChild,
-  omitProps,
-  deprecated
-} from '@instructure/ui-react-utils'
+import { ensureSingleChild, omitProps } from '@instructure/ui-react-utils'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
@@ -47,7 +43,6 @@ category: components/utilities
 ---
 **/
 @withStyle(generateStyle, generateComponentTheme)
-@deprecated('9.0.0', { onDismiss: null })
 class Mask extends Component<MaskProps> {
   static readonly componentId = 'Mask'
 

package/src/Mask/props.ts

@@ -41,11 +41,6 @@ type MaskOwnProps = {
    * provides a reference to the underlying html root element
    */
   elementRef?: (element: Element | null) => void
-
-  /**
-   * __Deprecated__: The component doesn't use onDismiss internally, will be removed in V9.
-   */
-  onDismiss?: () => void
 }
 
 type PropKeys = keyof MaskOwnProps
@@ -63,8 +58,7 @@ const propTypes: PropValidators<PropKeys> = {
   fullscreen: PropTypes.bool,
   children: PropTypes.node,
   onClick: PropTypes.func,
-  elementRef: PropTypes.func,
-  onDismiss: PropTypes.func // TODO: deprecated, remove in V9
+  elementRef: PropTypes.func
 }
 
 const allowedProps: AllowedPropKeys = [
@@ -72,10 +66,7 @@ const allowedProps: AllowedPropKeys = [
   'fullscreen',
   'children',
   'onClick',
-  'elementRef',
-
-  // TODO: deprecated, remove in V9
-  'onDismiss'
+  'elementRef'
 ]
 
 export type { MaskProps, MaskStyle }

package/src/Overlay/index.tsx

@@ -26,7 +26,7 @@ import React, { Component, ComponentClass, ReactElement } from 'react'
 
 import { testable } from '@instructure/ui-testable'
 import { createChainedFunction } from '@instructure/ui-utils'
-import { omitProps, pickProps, deprecated } from '@instructure/ui-react-utils'
+import { omitProps, pickProps } from '@instructure/ui-react-utils'
 
 import { Dialog } from '@instructure/ui-dialog'
 import type { DialogProps } from '@instructure/ui-dialog'
@@ -44,7 +44,6 @@ category: components
 ---
 **/
 @testable()
-@deprecated('9.0.0', { applicationElement: null })
 class Overlay extends Component<OverlayProps, OverlayState> {
   static allowedProps = allowedProps
   static propTypes = propTypes

package/src/Overlay/props.ts

@@ -49,15 +49,6 @@ type OverlayOwnProps = {
    * The type of `<Transition />` to use for animating in/out
    */
   transition?: TransitionType // passed as to Transition as `type`
-
-  // TODO: remove applicationElement in V9, it was removed from Dialog in v6
-  /**
-   * __Deprecated__: An element or a function returning an element to apply `aria-hidden` to
-   */
-  applicationElement?:
-    | React.ReactElement[]
-    | React.ReactElement
-    | (() => React.ReactElement[] | React.ReactElement)
 } & PropsForPortal &
   PropsForDialog &
   PropsForTransition
@@ -232,14 +223,7 @@ const propTypes: PropValidators<PropKeys> = {
   onEntered: PropTypes.func,
   onExit: PropTypes.func,
   onExiting: PropTypes.func,
-  onExited: PropTypes.func,
-
-  // TODO: deprecated, remove in V9
-  applicationElement: PropTypes.oneOfType([
-    PropTypes.arrayOf(PropTypes.element),
-    PropTypes.element,
-    PropTypes.func
-  ])
+  onExited: PropTypes.func
 }
 
 const allowedProps: AllowedPropKeys = [
@@ -267,10 +251,7 @@ const allowedProps: AllowedPropKeys = [
   'onEntered',
   'onExit',
   'onExiting',
-  'onExited',
-
-  // TODO: deprecated, remove in V9
-  'applicationElement'
+  'onExited'
 ]
 
 export type { OverlayProps, OverlayState }