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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-flex",
-  "version": "8.8.1-snapshot.8+7b83164f4",
+  "version": "8.9.1",
   "description": "A component that makes it easy to align content using flexbox CSS",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -25,17 +25,17 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/emotion": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/shared-types": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-react-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-view": "8.8.1-snapshot.8+7b83164f4",
+    "@instructure/console": "8.9.1",
+    "@instructure/emotion": "8.9.1",
+    "@instructure/shared-types": "8.9.1",
+    "@instructure/ui-react-utils": "8.9.1",
+    "@instructure/ui-view": "8.9.1",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-test-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-themes": "8.8.1-snapshot.8+7b83164f4"
+    "@instructure/ui-babel-preset": "8.9.1",
+    "@instructure/ui-test-utils": "8.9.1",
+    "@instructure/ui-themes": "8.9.1"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -43,6 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "7b83164f4c5872f3a217e010563f59bf584ae4fc"
+  "sideEffects": false
 }

package/src/Flex/Item/index.tsx

@@ -24,14 +24,15 @@
 
 /** @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 { FlexItemProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { FlexItemProps } from './props'
 
 /**
 ---
@@ -53,75 +54,8 @@ class Item extends Component<FlexItemProps> {
     this.props.makeStyles()
   }
 
-  /* eslint-disable react/require-default-props */
-  static 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
-  }
-  /* eslint-enable react/require-default-props */
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     as: 'span',
     // @ts-expect-error ts-migrate(6133) FIXME: 'el' is declared but its value is never read.
@@ -154,7 +88,7 @@ class Item extends Component<FlexItemProps> {
     return (
       <View
         {...props}
-        css={styles.flexItem}
+        css={styles?.flexItem}
         elementRef={elementRef}
         as={as}
         minHeight={dirColumn ? size : undefined}

package/src/Flex/Item/props.ts

@@ -0,0 +1,137 @@
+/*
+ * 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 { ThemeablePropTypes } from '@instructure/emotion'
+
+import type { AsElementType, PropValidators } from '@instructure/shared-types'
+import type { Spacing, WithStyleProps } from '@instructure/emotion'
+
+type FlexItemOwnProps = {
+  children?: React.ReactNode
+  as?: AsElementType
+  elementRef?: (...args: any[]) => any
+  margin?: Spacing
+  padding?: Spacing
+  align?: 'center' | 'start' | 'end' | 'stretch'
+  direction?: 'row' | 'column'
+  textAlign?: 'start' | 'center' | 'end'
+  overflowX?: 'auto' | 'hidden' | 'visible'
+  overflowY?: 'auto' | 'hidden' | 'visible'
+  shouldGrow?: boolean
+  shouldShrink?: boolean
+  size?: string
+  withVisualDebug?: boolean
+}
+
+type PropKeys = keyof FlexItemOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FlexItemProps = FlexItemOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * 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: AllowedPropKeys = [
+  'children',
+  'as',
+  'elementRef',
+  'margin',
+  'padding',
+  'align',
+  'direction',
+  'textAlign',
+  'overflowX',
+  'overflowY',
+  'shouldGrow',
+  'shouldShrink',
+  'size',
+  'withVisualDebug'
+]
+
+export type { FlexItemProps }
+export { propTypes, allowedProps }

package/src/Flex/Item/styles.ts

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 
-import { FlexItemProps } from './types'
+import { FlexItemProps } from './props'
 
 /**
  * ---

package/src/Flex/__examples__/Flex.examples.tsx

@@ -23,7 +23,7 @@
  */
 import React from 'react'
 import { Flex } from '../index'
-import { FlexProps } from '../types'
+import { FlexProps } from '../props'
 
 const regular = [
   <Flex.Item key="0">One</Flex.Item>,

package/src/Flex/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Children, Component } from 'react'
-import PropTypes from 'prop-types'
 
 import {
   safeCloneElement,
@@ -33,13 +32,15 @@ import {
   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 { FlexProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { FlexProps } from './props'
 
 /**
 ---
@@ -64,88 +65,8 @@ class Flex extends Component<FlexProps> {
 
   static Item = Item
 
-  static 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
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     children: null,
     as: 'span',
@@ -155,13 +76,7 @@ class Flex extends Component<FlexProps> {
     justifyItems: 'start',
     display: 'flex',
     withVisualDebug: false,
-    wrap: 'no-wrap',
-    width: undefined,
-    height: undefined,
-    padding: undefined,
-    margin: undefined,
-    alignItems: undefined,
-    textAlign: undefined
+    wrap: 'no-wrap'
   }
 
   renderChildren(children: any) {
@@ -201,7 +116,7 @@ class Flex extends Component<FlexProps> {
       return (
         <View
           {...passthroughProps(this.props)}
-          css={styles.flex}
+          css={styles?.flex}
           elementRef={elementRef}
           as={as}
           display={display}

package/src/Flex/props.ts

@@ -0,0 +1,150 @@
+/*
+ * 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 type { AsElementType, PropValidators } from '@instructure/shared-types'
+import type { Spacing, WithStyleProps } from '@instructure/emotion'
+
+type FlexOwnProps = {
+  children?: React.ReactNode | ((...args: any[]) => React.ReactNode)
+  as?: AsElementType
+  elementRef?: (...args: any[]) => any
+  height?: string | number
+  width?: string | number
+  margin?: Spacing
+  padding?: Spacing
+  display?: 'flex' | 'inline-flex'
+  textAlign?: 'start' | 'center' | 'end'
+  direction?: 'row' | 'column' | 'row-reverse' | 'column-reverse'
+  alignItems?: 'center' | 'start' | 'end' | 'stretch'
+  justifyItems?: 'center' | 'start' | 'end' | 'space-around' | 'space-between'
+  wrap?: 'wrap' | 'no-wrap' | 'wrap-reverse'
+  withVisualDebug?: boolean
+}
+
+type PropKeys = keyof FlexOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FlexProps = FlexOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * 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: AllowedPropKeys = [
+  'children',
+  'as',
+  'elementRef',
+  'height',
+  'width',
+  'margin',
+  'padding',
+  'display',
+  'textAlign',
+  'direction',
+  'alignItems',
+  'justifyItems',
+  'wrap',
+  'withVisualDebug'
+]
+
+export type { FlexProps }
+export { propTypes, allowedProps }