@instructure/ui-drawer-layout 8.8.1-snapshot.8 → 8.9.1

package/es/DrawerLayout/props.js

@@ -0,0 +1,49 @@
+/*
+ * 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';
+import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types';
+import { bidirectional } from '@instructure/ui-i18n';
+import { DrawerContent } from './DrawerContent';
+import { DrawerTray } from './DrawerTray';
+const propTypes = {
+  /**
+   * Exactly one of each of the following child types: `DrawerLayout.Content`, `DrawerLayout.Tray`
+   */
+  children: ChildrenPropTypes.oneOfEach([DrawerContent, DrawerTray]),
+
+  /**
+   * Min width for the `<DrawerLayout.Content />`
+   */
+  minWidth: PropTypes.string,
+
+  /**
+   * Function called when the `<DrawerLayout.Content />` is resized and hits the `minWidth` breakpoint
+   * Called with a boolean value, `true` if the tray is now overlaying the content or `false` if
+   * it is side by side
+   */
+  onOverlayTrayChange: PropTypes.func,
+  dir: PropTypes.oneOf(Object.values(bidirectional.DIRECTION))
+};
+const allowedProps = ['children', 'minWidth', 'onOverlayTrayChange', 'dir'];
+export { propTypes, allowedProps };

package/lib/DrawerLayout/DrawerContent/index.js

@@ -9,8 +9,6 @@ exports.DrawerContent = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _debounce = require("@instructure/debounce");
 
 var _getBoundingClientRect = require("@instructure/ui-dom-utils/lib/getBoundingClientRect.js");
@@ -25,6 +23,8 @@ var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 /**
@@ -107,6 +107,8 @@ let DrawerContent = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defa
   }
 
   render() {
+    var _this$props$styles;
+
     const _this$props = this.props,
           style = _this$props.style,
           label = _this$props.label,
@@ -116,25 +118,11 @@ let DrawerContent = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defa
       style: style,
       ref: this.handleContentRef,
       "aria-label": label,
-      css: this.props.styles.drawerContent
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.drawerContent
     }), this.props.children);
   }
 
-}, _class2.displayName = "DrawerContent", _class2.componentId = 'DrawerLayout.Content', _class2.locatorAttribute = 'data-drawer-content', _class2.propTypes = {
-  label: _propTypes.default.string.isRequired,
-  children: _propTypes.default.node,
-  contentRef: _propTypes.default.func,
-
-  /**
-   * Callback fired whenever the `<DrawerLayout.Content />` changes size
-   */
-  onSizeChange: _propTypes.default.func,
-  role: _propTypes.default.string,
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: _propTypes.default.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: _propTypes.default.object
-}, _class2.defaultProps = {
+}, _class2.displayName = "DrawerContent", _class2.componentId = 'DrawerLayout.Content', _class2.locatorAttribute = 'data-drawer-content', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   children: null,
   contentRef: el => {},
   onSizeChange: node => {},

package/{src/DrawerLayout/types.ts → lib/DrawerLayout/DrawerContent/props.js}

@@ -1,3 +1,14 @@
+"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)
  *
@@ -21,14 +32,17 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+const propTypes = {
+  label: _propTypes.default.string.isRequired,
+  children: _propTypes.default.node,
+  contentRef: _propTypes.default.func,
 
-import type { BidirectionalProps } from '@instructure/ui-i18n'
-
-export type DrawerLayoutOwnProps = {
-  minWidth?: string
-  onOverlayTrayChange?: (...args: any[]) => any
-  makeStyles?: (...args: any[]) => any
-  styles?: any
-}
-
-export type DrawerLayoutProps = DrawerLayoutOwnProps & BidirectionalProps
+  /**
+   * Callback fired whenever the `<DrawerLayout.Content />` changes size
+   */
+  onSizeChange: _propTypes.default.func,
+  role: _propTypes.default.string
+};
+exports.propTypes = propTypes;
+const allowedProps = ['label', 'children', 'contentRef', 'onSizeChange', 'role'];
+exports.allowedProps = allowedProps;

package/lib/DrawerLayout/DrawerTray/index.js

@@ -11,8 +11,6 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _emotion = require("@instructure/emotion");
 
 var _bidirectional = require("@instructure/ui-i18n/lib/bidirectional.js");
@@ -21,8 +19,6 @@ var _Transition = require("@instructure/ui-motion/lib/Transition");
 
 var _omitProps = require("@instructure/ui-react-utils/lib/omitProps.js");
 
-var _element = require("@instructure/ui-prop-types/lib/element.js");
-
 var _createChainedFunction = require("@instructure/ui-utils/lib/createChainedFunction.js");
 
 var _testable = require("@instructure/ui-testable/lib/testable.js");
@@ -39,6 +35,8 @@ var _theme = _interopRequireDefault(require("./theme"));
 
 var _index = require("../index");
 
+var _props = require("./props");
+
 const _excluded = ["label", "children", "render", "placement", "open", "onOpen", "onClose", "border", "shadow", "onEnter", "onEntering", "onEntered", "onExit", "onExiting", "onExited", "contentRef", "mountNode", "defaultFocusElement", "liveRegion", "onDismiss", "onTransition", "shouldReturnFocus", "shouldCloseOnEscape", "shouldCloseOnDocumentClick", "shouldContainFocus", "styles"];
 
 var _dec, _dec2, _dec3, _class, _class2, _temp;
@@ -177,12 +175,14 @@ let DrawerTray = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default
           styles = _this$props3.styles,
           props = (0, _objectWithoutProperties2.default)(_this$props3, _excluded);
     return (0, _emotion.jsx)(_index.DrawerLayoutContext.Consumer, null, shouldOverlayTray => {
+      var _this$props$styles;
+
       const portalOpen = this.state.portalOpen;
       const needsPortal = shouldOverlayTray && mountNode; // we have to handle the shadow version here,
       // because passing and handling it in styles.js makes it
       // rerender the component during the transition, breaking it
 
-      const trayStyles = shadow && shouldOverlayTray ? styles.drawerTrayWithShadow : styles.drawerTray;
+      const trayStyles = shadow && shouldOverlayTray ? styles === null || styles === void 0 ? void 0 : styles.drawerTrayWithShadow : styles === null || styles === void 0 ? void 0 : styles.drawerTray;
       let transitionIn = open;
 
       if (needsPortal && !portalOpen) {
@@ -215,7 +215,7 @@ let DrawerTray = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default
         liveRegion: liveRegion,
         onDismiss: onDismiss,
         as: "div",
-        css: this.props.styles.drawerTrayContent
+        css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.drawerTrayContent
       }, this.renderContent())));
 
       if (needsPortal) {
@@ -230,111 +230,8 @@ let DrawerTray = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default
     });
   }
 
-}, _class2.displayName = "DrawerTray", _class2.componentId = 'DrawerLayout.Tray', _class2.locatorAttribute = 'data-drawer-tray', _class2.propTypes = {
-  label: _propTypes.default.string.isRequired,
-  children: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.node]),
-  render: _propTypes.default.func,
-
-  /**
-   * Placement of the `<DrawerLayout.Tray />`
-   */
-  placement: _propTypes.default.oneOf(['start', 'end']),
-
-  /**
-   * If the tray is open or closed.
-   */
-  open: _propTypes.default.bool,
-
-  /**
-   * Called when the `<DrawerLayout.Tray />` is opened
-   */
-  onOpen: _propTypes.default.func,
-
-  /**
-   * Called when the `<DrawerLayout.Tray />` is closed
-   */
-  onClose: _propTypes.default.func,
-
-  /**
-   * Should the `<DrawerLayout.Tray />` have a border
-   */
-  border: _propTypes.default.bool,
-
-  /**
-   * Should the `<DrawerLayout.Tray />` have a shadow
-   */
-  shadow: _propTypes.default.bool,
-
-  /**
-   * Callback fired when the `<DrawerLayout.Tray />` transitions in/out
-   */
-  onTransition: _propTypes.default.func,
-
-  /**
-   * Callback fired before the `<DrawerLayout.Tray />` transitions in
-   */
-  onEnter: _propTypes.default.func,
-
-  /**
-   * Callback fired as the `<DrawerLayout.Tray />` begins to transition in
-   */
-  onEntering: _propTypes.default.func,
-
-  /**
-   * Callback fired after the `<DrawerLayout.Tray />` finishes transitioning in
-   */
-  onEntered: _propTypes.default.func,
-
-  /**
-   * Callback fired right before the `<DrawerLayout.Tray />` transitions out
-   */
-  onExit: _propTypes.default.func,
-
-  /**
-   * Callback fired as the `<DrawerLayout.Tray />` begins to transition out
-   */
-  onExiting: _propTypes.default.func,
-
-  /**
-   * Callback fired after the `<DrawerLayout.Tray />` finishes transitioning out
-   */
-  onExited: _propTypes.default.func,
-
-  /**
-   * Ref function for the `<DrawerLayout.Tray />` content
-   */
-  contentRef: _propTypes.default.func,
-
-  /**
-   * An element or a function returning an element to use as the mount node
-   * for the `<DrawerLayout.Tray />` when tray is overlaying content
-   */
-  mountNode: _propTypes.default.oneOfType([_element.element, _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, function returning an element, or array of elements that will not be hidden from
-   * the screen reader when the `<DrawerLayout.Tray />` is open
-   */
-  liveRegion: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.element), _propTypes.default.element, _propTypes.default.func]),
-  onDismiss: _propTypes.default.func,
-  shouldContainFocus: _propTypes.default.bool,
-  shouldReturnFocus: _propTypes.default.bool,
-  shouldCloseOnDocumentClick: _propTypes.default.bool,
-  shouldCloseOnEscape: _propTypes.default.bool,
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: _propTypes.default.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: _propTypes.default.object,
-  // eslint-disable-next-line react/require-default-props
-  dir: _propTypes.default.oneOf(Object.values(_bidirectional.bidirectional.DIRECTION))
-}, _class2.defaultProps = {
+}, _class2.displayName = "DrawerTray", _class2.componentId = 'DrawerLayout.Tray', _class2.locatorAttribute = 'data-drawer-tray', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   children: null,
-  render: void 0,
   shouldContainFocus: true,
   shouldCloseOnEscape: true,
   shouldCloseOnDocumentClick: true,
@@ -351,12 +248,7 @@ let DrawerTray = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default
   onExit: () => {},
   onExiting: () => {},
   onExited: () => {},
-  contentRef: node => {},
-  onClose: void 0,
-  onDismiss: void 0,
-  defaultFocusElement: void 0,
-  liveRegion: void 0,
-  onTransition: void 0
+  contentRef: node => {}
 }, _temp)) || _class) || _class) || _class);
 exports.DrawerTray = DrawerTray;
 var _default = DrawerTray;

package/lib/DrawerLayout/DrawerTray/props.js

@@ -0,0 +1,139 @@
+"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"));
+
+var _element = require("@instructure/ui-prop-types/lib/element.js");
+
+var _bidirectional = require("@instructure/ui-i18n/lib/bidirectional.js");
+
+/*
+ * 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 = {
+  label: _propTypes.default.string.isRequired,
+  children: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.node]),
+  render: _propTypes.default.func,
+
+  /**
+   * Placement of the `<DrawerLayout.Tray />`
+   */
+  placement: _propTypes.default.oneOf(['start', 'end']),
+
+  /**
+   * If the tray is open or closed.
+   */
+  open: _propTypes.default.bool,
+
+  /**
+   * Called when the `<DrawerLayout.Tray />` is opened
+   */
+  onOpen: _propTypes.default.func,
+
+  /**
+   * Called when the `<DrawerLayout.Tray />` is closed
+   */
+  onClose: _propTypes.default.func,
+
+  /**
+   * Should the `<DrawerLayout.Tray />` have a border
+   */
+  border: _propTypes.default.bool,
+
+  /**
+   * Should the `<DrawerLayout.Tray />` have a shadow
+   */
+  shadow: _propTypes.default.bool,
+
+  /**
+   * Callback fired when the `<DrawerLayout.Tray />` transitions in/out
+   */
+  onTransition: _propTypes.default.func,
+
+  /**
+   * Callback fired before the `<DrawerLayout.Tray />` transitions in
+   */
+  onEnter: _propTypes.default.func,
+
+  /**
+   * Callback fired as the `<DrawerLayout.Tray />` begins to transition in
+   */
+  onEntering: _propTypes.default.func,
+
+  /**
+   * Callback fired after the `<DrawerLayout.Tray />` finishes transitioning in
+   */
+  onEntered: _propTypes.default.func,
+
+  /**
+   * Callback fired right before the `<DrawerLayout.Tray />` transitions out
+   */
+  onExit: _propTypes.default.func,
+
+  /**
+   * Callback fired as the `<DrawerLayout.Tray />` begins to transition out
+   */
+  onExiting: _propTypes.default.func,
+
+  /**
+   * Callback fired after the `<DrawerLayout.Tray />` finishes transitioning out
+   */
+  onExited: _propTypes.default.func,
+
+  /**
+   * Ref function for the `<DrawerLayout.Tray />` content
+   */
+  contentRef: _propTypes.default.func,
+
+  /**
+   * An element or a function returning an element to use as the mount node
+   * for the `<DrawerLayout.Tray />` when tray is overlaying content
+   */
+  mountNode: _propTypes.default.oneOfType([_element.element, _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, function returning an element, or array of elements that will not be hidden from
+   * the screen reader when the `<DrawerLayout.Tray />` is open
+   */
+  liveRegion: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.element), _propTypes.default.element, _propTypes.default.func]),
+  onDismiss: _propTypes.default.func,
+  shouldContainFocus: _propTypes.default.bool,
+  shouldReturnFocus: _propTypes.default.bool,
+  shouldCloseOnDocumentClick: _propTypes.default.bool,
+  shouldCloseOnEscape: _propTypes.default.bool,
+  dir: _propTypes.default.oneOf(Object.values(_bidirectional.bidirectional.DIRECTION))
+};
+exports.propTypes = propTypes;
+const allowedProps = ['label', 'children', 'render', 'placement', 'open', 'onOpen', 'onClose', 'border', 'shadow', 'onTransition', 'onEnter', 'onEntering', 'onEntered', 'onExit', 'onExiting', 'onExited', 'contentRef', 'mountNode', 'defaultFocusElement', 'liveRegion', 'onDismiss', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'dir'];
+exports.allowedProps = allowedProps;