@instructure/ui-view 8.8.1-snapshot.3 → 8.9.0

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-view

package/es/ContextView/index.js

@@ -26,13 +26,12 @@ var _dec, _class, _class2, _temp;
 
 /** @jsx jsx */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
-import { jsx, withStyle, ThemeablePropTypes } from '@instructure/emotion';
-import { PositionPropTypes } from '@instructure/ui-position';
+import { jsx, withStyle } from '@instructure/emotion';
 import { omitProps } from '@instructure/ui-react-utils';
 import { View } from '../View';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
+import { propTypes, allowedProps } from './props';
 
 /**
 ---
@@ -104,78 +103,7 @@ let ContextView = (_dec = withStyle(generateStyle, generateComponentTheme), _dec
     }), children));
   }
 
-}, _class2.displayName = "ContextView", _class2.componentId = 'ContextView', _class2.propTypes = {
-  /**
-   * The element to render as the component root
-   */
-  as: PropTypes.elementType,
-
-  /**
-   * provides a reference to the underlying html root element
-   */
-  elementRef: PropTypes.func,
-
-  /**
-   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
-   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
-   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
-   */
-  margin: ThemeablePropTypes.spacing,
-
-  /**
-   * Valid values are `0`, `none`, `xxx-small`, `xx-small`, `x-small`,
-   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
-   * familiar CSS-like shorthand. For example: `padding="small x-large large"`.
-   */
-  padding: ThemeablePropTypes.spacing,
-  height: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-  width: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-  maxHeight: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-  maxWidth: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-  minHeight: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-  minWidth: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-
-  /**
-   * The children to render inside the `<ContextView />`
-   */
-  children: PropTypes.node,
-
-  /**
-   * Designates the text alignment within the `<ContextView />`
-   */
-  textAlign: PropTypes.oneOf(['start', 'center', 'end']),
-
-  /**
-   * Controls the shadow depth for the `<ContextView />`
-   */
-  shadow: ThemeablePropTypes.shadow,
-
-  /**
-   * Controls the z-index depth for the `<ContextView />`
-   */
-  stacking: ThemeablePropTypes.stacking,
-
-  /**
-   * Designates the background style of the `<ContextView />`
-   */
-  background: PropTypes.oneOf(['default', 'inverse']),
-
-  /**
-   * Specifies how the arrow for `<ContextView />` will be rendered.
-   * Ex. `placement="top"` will render with an arrow pointing down.
-   */
-  placement: PositionPropTypes.placement,
-
-  /**
-   * Activate an outline around the component to make building your
-   * layout easier
-   */
-  debug: PropTypes.bool,
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: PropTypes.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: PropTypes.object
-}, _class2.defaultProps = {
+}, _class2.displayName = "ContextView", _class2.componentId = 'ContextView', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
   as: 'span',
   elementRef: () => {},
   debug: false,
@@ -185,14 +113,7 @@ let ContextView = (_dec = withStyle(generateStyle, generateComponentTheme), _dec
   textAlign: 'start',
   background: 'default',
   shadow: 'resting',
-  placement: 'center end',
-  margin: void 0,
-  padding: void 0,
-  stacking: void 0,
-  maxWidth: void 0,
-  minWidth: void 0,
-  maxHeight: void 0,
-  minHeight: void 0
+  placement: 'center end'
 }, _temp)) || _class);
 export default ContextView;
 export { ContextView };

package/es/ContextView/props.js

@@ -0,0 +1,96 @@
+/*
+ * 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 { ThemeablePropTypes } from '@instructure/emotion';
+import { PositionPropTypes } from '@instructure/ui-position';
+const propTypes = {
+  /**
+   * The element to render as the component root
+   */
+  as: PropTypes.elementType,
+
+  /**
+   * provides a reference to the underlying html root element
+   */
+  elementRef: PropTypes.func,
+
+  /**
+   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+   */
+  margin: ThemeablePropTypes.spacing,
+
+  /**
+   * Valid values are `0`, `none`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `padding="small x-large large"`.
+   */
+  padding: ThemeablePropTypes.spacing,
+  height: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  width: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  maxHeight: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  maxWidth: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  minHeight: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  minWidth: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+
+  /**
+   * The children to render inside the `<ContextView />`
+   */
+  children: PropTypes.node,
+
+  /**
+   * Designates the text alignment within the `<ContextView />`
+   */
+  textAlign: PropTypes.oneOf(['start', 'center', 'end']),
+
+  /**
+   * Controls the shadow depth for the `<ContextView />`
+   */
+  shadow: ThemeablePropTypes.shadow,
+
+  /**
+   * Controls the z-index depth for the `<ContextView />`
+   */
+  stacking: ThemeablePropTypes.stacking,
+
+  /**
+   * Designates the background style of the `<ContextView />`
+   */
+  background: PropTypes.oneOf(['default', 'inverse']),
+
+  /**
+   * Specifies how the arrow for `<ContextView />` will be rendered.
+   * Ex. `placement="top"` will render with an arrow pointing down.
+   */
+  placement: PositionPropTypes.placement,
+
+  /**
+   * Activate an outline around the component to make building your
+   * layout easier
+   */
+  debug: PropTypes.bool
+};
+const allowedProps = ['as', 'elementRef', 'margin', 'padding', 'height', 'width', 'maxHeight', 'maxWidth', 'minHeight', 'minWidth', 'children', 'textAlign', 'shadow', 'stacking', 'background', 'placement', 'debug'];
+export { propTypes, allowedProps };

package/es/View/index.js

@@ -36,7 +36,8 @@ import { getElementType, omitProps, pickProps, passthroughProps } from '@instruc
 import { jsx, withStyle } from '@instructure/emotion';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
-import { allowedProps, propTypes } from './types';
+import { propTypes, allowedProps } from './props';
+
 /**
 ---
 category: components
@@ -47,7 +48,6 @@ API:
 @module View
 
 **/
-
 let View = (_dec = bidirectional(), _dec2 = withStyle(generateStyle, generateComponentTheme), _dec(_class = _dec2(_class = (_temp = _class2 = class View extends Component {
   // TODO: Remove this code once all components are using passthroughProps in place
   // of omitProps and have removed this function
@@ -172,13 +172,17 @@ let View = (_dec = bidirectional(), _dec2 = withStyle(generateStyle, generateCom
   focusColor: 'info',
   shouldAnimateFocus: true
 }, _class2.omitViewProps = (props, Component) => {
+  // We don't want the theming and styling props to pass
+  // (these are added and handled by the `@withStyle` decorator)
+  const propsToOmit = [..._class2.allowedProps, 'styles', 'makeStyles', 'themeOverride'];
+
   if (process.env.NODE_ENV !== 'production') {
-    Object.keys(pickProps(props, _class2.allowedProps)).forEach(prop => {
+    Object.keys(pickProps(props, propsToOmit)).forEach(prop => {
       error(false, `[${Component.name}] prop '${prop}' is not allowed.`);
     });
   }
 
-  return omitProps(props, _class2.allowedProps);
+  return omitProps(props, propsToOmit);
 }, _temp)) || _class) || _class);
 export default View;
 export { View };

package/es/View/{types.js → props.js}

@@ -25,7 +25,7 @@ import PropTypes from 'prop-types';
 import { cursor as cursorPropTypes } from '@instructure/ui-prop-types';
 import { bidirectional } from '@instructure/ui-i18n';
 import { ThemeablePropTypes } from '@instructure/emotion';
-export const propTypes = {
+const propTypes = {
   as: PropTypes.elementType,
   elementRef: PropTypes.func,
   display: PropTypes.oneOf(['auto', 'inline', 'block', 'inline-block', 'flex', 'inline-flex']),
@@ -58,11 +58,10 @@ export const propTypes = {
   focusColor: PropTypes.oneOf(['info', 'inverse', 'success', 'danger']),
   shouldAnimateFocus: PropTypes.bool,
   withVisualDebug: PropTypes.bool,
-  makeStyles: PropTypes.func,
-  styles: PropTypes.object,
   dir: PropTypes.oneOf(Object.values(bidirectional.DIRECTION))
-}; //This variable will be attached as static property on the `View` component
-//so we don't rely on the `PropTypes` validators for our internal logic.
-//This means on prod builds the consuming applications can safely delete propTypes.
+}; // This variable will be attached as static property on the `View` component
+// so we don't rely on the `PropTypes` validators for our internal logic.
+// This means on prod builds the consuming applications can safely delete propTypes.
 
-export const allowedProps = ['as', 'background', 'borderColor', 'borderRadius', 'borderWidth', 'cursor', 'dir', 'display', 'elementRef', 'focusColor', 'focusPosition', 'height', 'insetBlockEnd', 'insetBlockStart', 'insetInlineEnd', 'insetInlineStart', 'makeStyles', 'margin', 'maxHeight', 'maxWidth', 'minHeight', 'minWidth', 'overflowX', 'overflowY', 'padding', 'position', 'shadow', 'shouldAnimateFocus', 'stacking', 'styles', 'textAlign', 'width', 'withFocusOutline', 'withVisualDebug'];
+const allowedProps = ['as', 'background', 'borderColor', 'borderRadius', 'borderWidth', 'children', 'cursor', 'dir', 'display', 'elementRef', 'focusColor', 'focusPosition', 'height', 'insetBlockEnd', 'insetBlockStart', 'insetInlineEnd', 'insetInlineStart', 'margin', 'maxHeight', 'maxWidth', 'minHeight', 'minWidth', 'overflowX', 'overflowY', 'padding', 'position', 'shadow', 'shouldAnimateFocus', 'stacking', 'textAlign', 'width', 'withFocusOutline', 'withVisualDebug'];
+export { propTypes, allowedProps };

package/lib/ContextView/index.js

@@ -9,12 +9,8 @@ exports.ContextView = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _emotion = require("@instructure/emotion");
 
-var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.js");
-
 var _omitProps = require("@instructure/ui-react-utils/lib/omitProps.js");
 
 var _View = require("../View");
@@ -23,6 +19,8 @@ var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _class, _class2, _temp;
 
 /**
@@ -95,78 +93,7 @@ let ContextView = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
     }), children));
   }
 
-}, _class2.displayName = "ContextView", _class2.componentId = 'ContextView', _class2.propTypes = {
-  /**
-   * The element to render as the component root
-   */
-  as: _propTypes.default.elementType,
-
-  /**
-   * provides a reference to the underlying html root element
-   */
-  elementRef: _propTypes.default.func,
-
-  /**
-   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
-   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
-   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
-   */
-  margin: _emotion.ThemeablePropTypes.spacing,
-
-  /**
-   * Valid values are `0`, `none`, `xxx-small`, `xx-small`, `x-small`,
-   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
-   * familiar CSS-like shorthand. For example: `padding="small x-large large"`.
-   */
-  padding: _emotion.ThemeablePropTypes.spacing,
-  height: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-  width: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-  maxHeight: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-  maxWidth: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-  minHeight: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-  minWidth: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-
-  /**
-   * The children to render inside the `<ContextView />`
-   */
-  children: _propTypes.default.node,
-
-  /**
-   * Designates the text alignment within the `<ContextView />`
-   */
-  textAlign: _propTypes.default.oneOf(['start', 'center', 'end']),
-
-  /**
-   * Controls the shadow depth for the `<ContextView />`
-   */
-  shadow: _emotion.ThemeablePropTypes.shadow,
-
-  /**
-   * Controls the z-index depth for the `<ContextView />`
-   */
-  stacking: _emotion.ThemeablePropTypes.stacking,
-
-  /**
-   * Designates the background style of the `<ContextView />`
-   */
-  background: _propTypes.default.oneOf(['default', 'inverse']),
-
-  /**
-   * Specifies how the arrow for `<ContextView />` will be rendered.
-   * Ex. `placement="top"` will render with an arrow pointing down.
-   */
-  placement: _PositionPropTypes.PositionPropTypes.placement,
-
-  /**
-   * Activate an outline around the component to make building your
-   * layout easier
-   */
-  debug: _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
-}, _class2.defaultProps = {
+}, _class2.displayName = "ContextView", _class2.componentId = 'ContextView', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   as: 'span',
   elementRef: () => {},
   debug: false,
@@ -176,14 +103,7 @@ let ContextView = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
   textAlign: 'start',
   background: 'default',
   shadow: 'resting',
-  placement: 'center end',
-  margin: void 0,
-  padding: void 0,
-  stacking: void 0,
-  maxWidth: void 0,
-  minWidth: void 0,
-  maxHeight: void 0,
-  minHeight: void 0
+  placement: 'center end'
 }, _temp)) || _class);
 exports.ContextView = ContextView;
 var _default = ContextView;

package/lib/ContextView/props.js

@@ -0,0 +1,109 @@
+"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 _emotion = require("@instructure/emotion");
+
+var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.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 = {
+  /**
+   * The element to render as the component root
+   */
+  as: _propTypes.default.elementType,
+
+  /**
+   * provides a reference to the underlying html root element
+   */
+  elementRef: _propTypes.default.func,
+
+  /**
+   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+   */
+  margin: _emotion.ThemeablePropTypes.spacing,
+
+  /**
+   * Valid values are `0`, `none`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `padding="small x-large large"`.
+   */
+  padding: _emotion.ThemeablePropTypes.spacing,
+  height: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+  width: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+  maxHeight: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+  maxWidth: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+  minHeight: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+  minWidth: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+
+  /**
+   * The children to render inside the `<ContextView />`
+   */
+  children: _propTypes.default.node,
+
+  /**
+   * Designates the text alignment within the `<ContextView />`
+   */
+  textAlign: _propTypes.default.oneOf(['start', 'center', 'end']),
+
+  /**
+   * Controls the shadow depth for the `<ContextView />`
+   */
+  shadow: _emotion.ThemeablePropTypes.shadow,
+
+  /**
+   * Controls the z-index depth for the `<ContextView />`
+   */
+  stacking: _emotion.ThemeablePropTypes.stacking,
+
+  /**
+   * Designates the background style of the `<ContextView />`
+   */
+  background: _propTypes.default.oneOf(['default', 'inverse']),
+
+  /**
+   * Specifies how the arrow for `<ContextView />` will be rendered.
+   * Ex. `placement="top"` will render with an arrow pointing down.
+   */
+  placement: _PositionPropTypes.PositionPropTypes.placement,
+
+  /**
+   * Activate an outline around the component to make building your
+   * layout easier
+   */
+  debug: _propTypes.default.bool
+};
+exports.propTypes = propTypes;
+const allowedProps = ['as', 'elementRef', 'margin', 'padding', 'height', 'width', 'maxHeight', 'maxWidth', 'minHeight', 'minWidth', 'children', 'textAlign', 'shadow', 'stacking', 'background', 'placement', 'debug'];
+exports.allowedProps = allowedProps;