@instructure/ui-flex 8.8.1-snapshot.8 → 8.9.1

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.9.1](https://github.com/instructure/instructure-ui/compare/v8.9.0...v8.9.1) (2021-09-16)
+
+**Note:** Version bump only for package @instructure/ui-flex
+
+# [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-flex

package/es/Flex/Item/index.js

@@ -26,11 +26,11 @@ var _dec, _class, _class2, _temp;
 
 /** @jsx jsx */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
 import { omitProps } from '@instructure/ui-react-utils';
 import { View } from '@instructure/ui-view';
-import { withStyle, jsx, ThemeablePropTypes } from '@instructure/emotion';
+import { withStyle, jsx } from '@instructure/emotion';
 import generateStyle from './styles';
+import { propTypes, allowedProps } from './props';
 
 /**
 ---
@@ -46,8 +46,6 @@ let Item = (_dec = withStyle(generateStyle), _dec(_class = (_temp = _class2 = cl
   componentDidUpdate() {
     this.props.makeStyles();
   }
-  /* eslint-disable react/require-default-props */
-
 
   render() {
     const props = omitProps(this.props, Item.propTypes);
@@ -67,7 +65,7 @@ let Item = (_dec = withStyle(generateStyle), _dec(_class = (_temp = _class2 = cl
     const dirColumn = direction === 'column';
     const dirRow = direction === 'row';
     return jsx(View, Object.assign({}, props, {
-      css: styles.flexItem,
+      css: styles === null || styles === void 0 ? void 0 : styles.flexItem,
       elementRef: elementRef,
       as: as,
       minHeight: dirColumn ? size : void 0,
@@ -81,86 +79,7 @@ let Item = (_dec = withStyle(generateStyle), _dec(_class = (_temp = _class2 = cl
     }), children);
   }
 
-}, _class2.displayName = "Item", _class2.componentId = 'Flex.Item', _class2.propTypes = {
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: PropTypes.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: PropTypes.object,
-
-  /**
-   * The children to render inside the Item`
-   */
-  children: PropTypes.node,
-
-  /**
-   * the element type to render as
-   */
-  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,
-
-  /**
-   * overrides the parent Flex's alignItems prop, if needed
-   */
-  align: PropTypes.oneOf(['center', 'start', 'end', 'stretch']),
-
-  /**
-   * Inherits from the parent Flex component
-   */
-  direction: PropTypes.oneOf(['row', 'column']),
-
-  /**
-   * Designates the text alignment inside the Item
-   */
-  textAlign: PropTypes.oneOf(['start', 'center', 'end']),
-
-  /**
-   * Handles horizontal overflow
-   */
-  overflowX: PropTypes.oneOf(['auto', 'hidden', 'visible']),
-
-  /**
-   * Handles vertical overflow
-   */
-  overflowY: PropTypes.oneOf(['auto', 'hidden', 'visible']),
-
-  /**
-   * Should the FlexItem grow to fill any available space?
-   */
-  shouldGrow: PropTypes.bool,
-
-  /**
-   * Should the FlexItem shrink (stopping at its `size`)?
-   */
-  shouldShrink: PropTypes.bool,
-
-  /**
-   * Sets the base size of the FlexItem (width if direction is `row`; height if direction is `column`)
-   */
-  size: PropTypes.string,
-
-  /**
-   * Places dashed lines around the component's borders to help debug your layout
-   */
-  withVisualDebug: PropTypes.bool
-}, _class2.defaultProps = {
+}, _class2.displayName = "Item", _class2.componentId = 'Flex.Item', _class2.propTypes = propTypes, _class2.allowedProps = allowedProps, _class2.defaultProps = {
   as: 'span',
   elementRef: el => {},
   shouldGrow: false,

package/es/Flex/Item/props.js

@@ -0,0 +1,102 @@
+/*
+ * 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';
+const propTypes = {
+  /**
+   * The children to render inside the Item`
+   */
+  children: PropTypes.node,
+
+  /**
+   * the element type to render as
+   */
+  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,
+
+  /**
+   * overrides the parent Flex's alignItems prop, if needed
+   */
+  align: PropTypes.oneOf(['center', 'start', 'end', 'stretch']),
+
+  /**
+   * Inherits from the parent Flex component
+   */
+  direction: PropTypes.oneOf(['row', 'column']),
+
+  /**
+   * Designates the text alignment inside the Item
+   */
+  textAlign: PropTypes.oneOf(['start', 'center', 'end']),
+
+  /**
+   * Handles horizontal overflow
+   */
+  overflowX: PropTypes.oneOf(['auto', 'hidden', 'visible']),
+
+  /**
+   * Handles vertical overflow
+   */
+  overflowY: PropTypes.oneOf(['auto', 'hidden', 'visible']),
+
+  /**
+   * Should the FlexItem grow to fill any available space?
+   */
+  shouldGrow: PropTypes.bool,
+
+  /**
+   * Should the FlexItem shrink (stopping at its `size`)?
+   */
+  shouldShrink: PropTypes.bool,
+
+  /**
+   * Sets the base size of the FlexItem (width if direction is `row`; height if direction is `column`)
+   */
+  size: PropTypes.string,
+
+  /**
+   * Places dashed lines around the component's borders to help debug your layout
+   */
+  withVisualDebug: PropTypes.bool
+};
+const allowedProps = ['children', 'as', 'elementRef', 'margin', 'padding', 'align', 'direction', 'textAlign', 'overflowX', 'overflowY', 'shouldGrow', 'shouldShrink', 'size', 'withVisualDebug'];
+export { propTypes, allowedProps };

package/es/Flex/index.js

@@ -26,13 +26,13 @@ var _dec, _class, _class2, _temp;
 
 /** @jsx jsx */
 import { Children, Component } from 'react';
-import PropTypes from 'prop-types';
 import { safeCloneElement, passthroughProps, matchComponentTypes, callRenderProp } from '@instructure/ui-react-utils';
 import { View } from '@instructure/ui-view';
-import { withStyle, jsx, ThemeablePropTypes } from '@instructure/emotion';
+import { withStyle, jsx } from '@instructure/emotion';
 import { Item } from './Item';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
+import { propTypes, allowedProps } from './props';
 
 /**
 ---
@@ -82,7 +82,7 @@ let Flex = (_dec = withStyle(generateStyle, generateComponentTheme), _dec(_class
 
     if (children && Children.count(children) > 0) {
       return jsx(View, Object.assign({}, passthroughProps(this.props), {
-        css: styles.flex,
+        css: styles === null || styles === void 0 ? void 0 : styles.flex,
         elementRef: elementRef,
         as: as,
         display: display,
@@ -98,88 +98,7 @@ let Flex = (_dec = withStyle(generateStyle, generateComponentTheme), _dec(_class
     }
   }
 
-}, _class2.displayName = "Flex", _class2.componentId = 'Flex', _class2.Item = Item, _class2.propTypes = {
-  /**
-   * It's recommended that you use `Flex.Item` for children, but you can also pass any markup or a function
-   * returning markup. Note that if you do not use `Flex.Item`, the `withVisualDebug` and `direction` props
-   * will not automatically be set on the children.
-   */
-  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * the element type to render as
-   */
-  as: PropTypes.elementType,
-
-  /**
-   * provides a reference to the underlying html root element
-   */
-  elementRef: PropTypes.func,
-
-  /**
-   * Sets the height of the component's container (optional)
-   */
-  height: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-
-  /**
-   * Sets the width of the component's container (optional)
-   */
-  width: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-
-  /**
-   * 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,
-
-  /**
-   * Sets the CSS display rule for the component's container
-   */
-  display: PropTypes.oneOf(['flex', 'inline-flex']),
-
-  /**
-   * Designates the text alignment
-   */
-  textAlign: PropTypes.oneOf(['start', 'center', 'end']),
-
-  /**
-   * Sets the flex-direction to row (horizontal) or column (vertical)
-   */
-  direction: PropTypes.oneOf(['row', 'column', 'row-reverse', 'column-reverse']),
-
-  /**
-   * Aligns Flex.Items on the vertical axis (horizontal if direction is column)
-   */
-  alignItems: PropTypes.oneOf(['center', 'start', 'end', 'stretch']),
-
-  /**
-   * Aligns Flex.Items on the horizontal axis (vertical if direction is column)
-   */
-  justifyItems: PropTypes.oneOf(['center', 'start', 'end', 'space-around', 'space-between']),
-
-  /**
-   * Determines if the Flex.Items should wrap when they exceed their container's width
-   */
-  wrap: PropTypes.oneOf(['wrap', 'no-wrap', 'wrap-reverse']),
-
-  /**
-   * Activate a dotted outline around the component to make building your
-   * layout easier
-   */
-  withVisualDebug: 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 = "Flex", _class2.componentId = 'Flex', _class2.Item = Item, _class2.propTypes = propTypes, _class2.allowedProps = allowedProps, _class2.defaultProps = {
   children: null,
   as: 'span',
   elementRef: el => {},
@@ -187,13 +106,7 @@ let Flex = (_dec = withStyle(generateStyle, generateComponentTheme), _dec(_class
   justifyItems: 'start',
   display: 'flex',
   withVisualDebug: false,
-  wrap: 'no-wrap',
-  width: void 0,
-  height: void 0,
-  padding: void 0,
-  margin: void 0,
-  alignItems: void 0,
-  textAlign: void 0
+  wrap: 'no-wrap'
 }, _temp)) || _class);
 export default Flex;
 export { Flex, Item as FlexItem };

package/es/Flex/props.js

@@ -0,0 +1,105 @@
+/*
+ * 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';
+const propTypes = {
+  /**
+   * It's recommended that you use `Flex.Item` for children, but you can also pass any markup or a function
+   * returning markup. Note that if you do not use `Flex.Item`, the `withVisualDebug` and `direction` props
+   * will not automatically be set on the children.
+   */
+  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * the element type to render as
+   */
+  as: PropTypes.elementType,
+
+  /**
+   * provides a reference to the underlying html root element
+   */
+  elementRef: PropTypes.func,
+
+  /**
+   * Sets the height of the component's container (optional)
+   */
+  height: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+
+  /**
+   * Sets the width of the component's container (optional)
+   */
+  width: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+
+  /**
+   * 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,
+
+  /**
+   * Sets the CSS display rule for the component's container
+   */
+  display: PropTypes.oneOf(['flex', 'inline-flex']),
+
+  /**
+   * Designates the text alignment
+   */
+  textAlign: PropTypes.oneOf(['start', 'center', 'end']),
+
+  /**
+   * Sets the flex-direction to row (horizontal) or column (vertical)
+   */
+  direction: PropTypes.oneOf(['row', 'column', 'row-reverse', 'column-reverse']),
+
+  /**
+   * Aligns Flex.Items on the vertical axis (horizontal if direction is column)
+   */
+  alignItems: PropTypes.oneOf(['center', 'start', 'end', 'stretch']),
+
+  /**
+   * Aligns Flex.Items on the horizontal axis (vertical if direction is column)
+   */
+  justifyItems: PropTypes.oneOf(['center', 'start', 'end', 'space-around', 'space-between']),
+
+  /**
+   * Determines if the Flex.Items should wrap when they exceed their container's width
+   */
+  wrap: PropTypes.oneOf(['wrap', 'no-wrap', 'wrap-reverse']),
+
+  /**
+   * Activate a dotted outline around the component to make building your
+   * layout easier
+   */
+  withVisualDebug: PropTypes.bool
+};
+const allowedProps = ['children', 'as', 'elementRef', 'height', 'width', 'margin', 'padding', 'display', 'textAlign', 'direction', 'alignItems', 'justifyItems', 'wrap', 'withVisualDebug'];
+export { propTypes, allowedProps };