@instructure/ui-buttons 8.8.0 → 8.8.1-snapshot.63

package/src/CloseButton/index.tsx

@@ -24,19 +24,20 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { IconXSolid } from '@instructure/ui-icons'
 import { ScreenReaderContent } from '@instructure/ui-a11y-content'
 import { testable } from '@instructure/ui-testable'
 import { getInteraction, passthroughProps } from '@instructure/ui-react-utils'
 
-import { withStyle, jsx, ThemeablePropTypes } from '@instructure/emotion'
+import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
 import { BaseButton } from '../BaseButton'
-import { CloseButtonProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { CloseButtonProps } from './props'
 
 /**
 ---
@@ -48,94 +49,19 @@ category: components
 class CloseButton extends Component<CloseButtonProps> {
   static readonly componentId = 'CloseButton'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    /**
-     * An accessible label for the `CloseButton` (required)
-     */
-    screenReaderLabel: PropTypes.oneOfType([PropTypes.string, PropTypes.node])
-      .isRequired,
-    /**
-     * Specifies the color for the `CloseButton`.
-     */
-    color: PropTypes.oneOf(['primary', 'primary-inverse']),
-    /**
-     * Specifies if interaction with the `CloseButton` is enabled, disabled, or readonly.
-     */
-    interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
-    /**
-     * Provides a reference to the `CloseButton`'s underlying html element.
-     */
-    elementRef: PropTypes.func,
-    /**
-     * The size of the `CloseButton`
-     */
-    size: PropTypes.oneOf(['small', 'medium', 'large']),
-    /**
-     * Callback fired when the `CloseButton` is clicked.
-     */
-    onClick: 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,
-    /**
-     * Specifies the placement of the `CloseButton`
-     */
-    placement: PropTypes.oneOf(['start', 'end', 'static']),
-    /**
-     * Specifies the offset distance for the `CloseButton` with respect to both the top and start/end of the container.
-     * Note that for this property to have an effect, the `placement` prop must be set to either `start` or `end`. The
-     * offset will also be created with respect to a positioned parent. If it does not appear to be working, try setting
-     * the `position` of the parent container to `relative`.
-     */
-    offset: PropTypes.oneOf(['none', 'x-small', 'small', 'medium']),
-    /**
-     * Specifies the type of the `Button`'s underlying html element.
-     */
-    type: PropTypes.oneOf(['button', 'submit', 'reset']),
-    /**
-     * The element to render as the component root, `CloseButton` by default.
-     */
-    as: PropTypes.elementType,
-    /**
-     * Specifies an href attribute for the `CloseButton`'s underlying html element.
-     */
-    href: PropTypes.string,
-    /**
-     * Specify a mouse cursor to use when hovering over the `CloseButton`.
-     */
-    cursor: PropTypes.string,
-    /**
-     * Specifies the tabindex of the `CloseButton`.
-     */
-    tabIndex: PropTypes.oneOfType([PropTypes.number, PropTypes.string])
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
-    screenReaderLabel: undefined,
     // @ts-expect-error ts-migrate(6133) FIXME: 'event' is declared but its value is never read.
     onClick: (event) => {},
-    elementRef: undefined,
-    color: undefined,
     // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
-    interaction: undefined,
-    disabled: undefined,
-    readOnly: undefined,
     type: 'button',
     placement: 'static',
     offset: 'x-small',
     size: 'small',
     margin: '0',
     as: 'button',
-    href: undefined,
-    cursor: 'pointer',
-    tabIndex: undefined
+    cursor: 'pointer'
   }
 
   componentDidMount() {
@@ -177,7 +103,7 @@ class CloseButton extends Component<CloseButtonProps> {
     } = this.props
 
     return (
-      <span {...passthroughProps(props)} css={styles.closeButton}>
+      <span {...passthroughProps(props)} css={styles?.closeButton}>
         <BaseButton
           renderIcon={IconXSolid}
           elementRef={elementRef}

package/src/CloseButton/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 PropTypes from 'prop-types'
+import { ThemeablePropTypes } from '@instructure/emotion'
+
+import type { Spacing, WithStyleProps } from '@instructure/emotion'
+import type { AsElementType, PropValidators } from '@instructure/shared-types'
+
+type CloseButtonOwnProps = {
+  screenReaderLabel: string | React.ReactNode
+  color?: 'primary' | 'primary-inverse'
+  interaction?: 'enabled' | 'disabled' | 'readonly'
+  elementRef?: (...args: any[]) => any
+  size?: 'small' | 'medium' | 'large'
+  onClick?: (...args: any[]) => any
+  margin?: Spacing
+  placement?: 'start' | 'end' | 'static'
+  offset?: 'none' | 'x-small' | 'small' | 'medium'
+  type?: 'button' | 'submit' | 'reset'
+  as?: AsElementType
+  href?: string
+  cursor?: string
+  tabIndex?: number | string
+}
+
+type PropKeys = keyof CloseButtonOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type CloseButtonProps = CloseButtonOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * An accessible label for the `CloseButton` (required)
+   */
+  screenReaderLabel: PropTypes.oneOfType([PropTypes.string, PropTypes.node])
+    .isRequired,
+  /**
+   * Specifies the color for the `CloseButton`.
+   */
+  color: PropTypes.oneOf(['primary', 'primary-inverse']),
+  /**
+   * Specifies if interaction with the `CloseButton` is enabled, disabled, or readonly.
+   */
+  interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
+  /**
+   * Provides a reference to the `CloseButton`'s underlying html element.
+   */
+  elementRef: PropTypes.func,
+  /**
+   * The size of the `CloseButton`
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Callback fired when the `CloseButton` is clicked.
+   */
+  onClick: 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,
+  /**
+   * Specifies the placement of the `CloseButton`
+   */
+  placement: PropTypes.oneOf(['start', 'end', 'static']),
+  /**
+   * Specifies the offset distance for the `CloseButton` with respect to both the top and start/end of the container.
+   * Note that for this property to have an effect, the `placement` prop must be set to either `start` or `end`. The
+   * offset will also be created with respect to a positioned parent. If it does not appear to be working, try setting
+   * the `position` of the parent container to `relative`.
+   */
+  offset: PropTypes.oneOf(['none', 'x-small', 'small', 'medium']),
+  /**
+   * Specifies the type of the `Button`'s underlying html element.
+   */
+  type: PropTypes.oneOf(['button', 'submit', 'reset']),
+  /**
+   * The element to render as the component root, `CloseButton` by default.
+   */
+  as: PropTypes.elementType,
+  /**
+   * Specifies an href attribute for the `CloseButton`'s underlying html element.
+   */
+  href: PropTypes.string,
+  /**
+   * Specify a mouse cursor to use when hovering over the `CloseButton`.
+   */
+  cursor: PropTypes.string,
+  /**
+   * Specifies the tabindex of the `CloseButton`.
+   */
+  tabIndex: PropTypes.oneOfType([PropTypes.number, PropTypes.string])
+}
+
+const allowedProps: AllowedPropKeys = [
+  'as',
+  'color',
+  'cursor',
+  'elementRef',
+  'href',
+  'interaction',
+  'margin',
+  'offset',
+  'onClick',
+  'placement',
+  'screenReaderLabel',
+  'size',
+  'tabIndex',
+  'type'
+]
+
+export type { CloseButtonProps }
+export { propTypes, allowedProps }

package/src/CloseButton/styles.ts

@@ -23,7 +23,7 @@
  */
 
 import { CloseButtonTheme } from '@instructure/shared-types'
-import { CloseButtonProps } from './types'
+import { CloseButtonProps } from './props'
 
 /**
  * ---

package/src/CloseButton/theme.ts

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 
-import { Theme } from '@instructure/ui-themes'
+import type { Theme } from '@instructure/ui-themes'
 import { CloseButtonTheme } from '@instructure/shared-types'
 
 /**

package/src/CondensedButton/index.tsx

@@ -23,16 +23,17 @@
  */
 
 import React, { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { testable } from '@instructure/ui-testable'
 import { passthroughProps } from '@instructure/ui-react-utils'
 
-import { withStyle, ThemeablePropTypes } from '@instructure/emotion'
+import { withStyle } from '@instructure/emotion'
 
 import generateComponentTheme from './theme'
 import { BaseButton } from '../BaseButton'
-import { CondensedButtonProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { CondensedButtonProps } from './props'
 
 /**
 ---
@@ -45,56 +46,8 @@ category: components
 class CondensedButton extends Component<CondensedButtonProps> {
   static readonly componentId = 'CondensedButton'
 
-  static propTypes = {
-    /**
-     * Specifies the `CondensedButton` children.
-     */
-    children: PropTypes.node,
-    /**
-     * Specifies the type of the `CondensedButton`'s underlying html element.
-     */
-    type: PropTypes.oneOf(['button', 'submit', 'reset']),
-    /**
-     * The size of the `CondensedButton`
-     */
-    size: PropTypes.oneOf(['small', 'medium', 'large']),
-    /**
-     * Provides a reference to the `CondensedButton`'s underlying html element.
-     */
-    elementRef: PropTypes.func,
-    /**
-     * The element to render as the component root, `button` by default.
-     */
-    as: PropTypes.elementType,
-    /**
-     * Specifies if interaction with the `CondensedButton` is enabled, disabled, or readonly.
-     */
-    interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
-    /**
-     * Specifies the color for the `CondensedButton`.
-     */
-    color: PropTypes.oneOf(['primary', 'primary-inverse']),
-    /**
-     * 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,
-    /**
-     * Specify a mouse cursor to use when hovering over the button.
-     * The `pointer` cursor is used by default.
-     */
-    cursor: PropTypes.string,
-    /**
-     * Specifies an href attribute for the `CondensedButton`'s underlying html element.
-     */
-    href: PropTypes.string,
-    /**
-     * An icon, or function that returns an icon.
-     */
-    renderIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func])
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     children: null,
     type: 'button',
@@ -103,12 +56,9 @@ class CondensedButton extends Component<CondensedButtonProps> {
     elementRef: (el) => {},
     as: 'button',
     // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
-    interaction: undefined,
     color: 'primary',
     margin: '0',
-    cursor: 'pointer',
-    href: undefined,
-    renderIcon: undefined
+    cursor: 'pointer'
   }
 
   _baseButton = null

package/src/CondensedButton/props.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 { Spacing } from '@instructure/emotion'
+import type { AsElementType, PropValidators } from '@instructure/shared-types'
+
+type CondensedButtonOwnProps = {
+  children?: React.ReactNode
+  type?: 'button' | 'submit' | 'reset'
+  size?: 'small' | 'medium' | 'large'
+  elementRef?: (...args: any[]) => any
+  as?: AsElementType
+  interaction?: 'enabled' | 'disabled' | 'readonly'
+  color?: 'primary' | 'primary-inverse'
+  margin?: Spacing
+  cursor?: string
+  href?: string
+  renderIcon?: React.ReactNode | ((...args: any[]) => any)
+}
+
+type PropKeys = keyof CondensedButtonOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type CondensedButtonProps = CondensedButtonOwnProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * Specifies the `CondensedButton` children.
+   */
+  children: PropTypes.node,
+  /**
+   * Specifies the type of the `CondensedButton`'s underlying html element.
+   */
+  type: PropTypes.oneOf(['button', 'submit', 'reset']),
+  /**
+   * The size of the `CondensedButton`
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Provides a reference to the `CondensedButton`'s underlying html element.
+   */
+  elementRef: PropTypes.func,
+  /**
+   * The element to render as the component root, `button` by default.
+   */
+  as: PropTypes.elementType,
+  /**
+   * Specifies if interaction with the `CondensedButton` is enabled, disabled, or readonly.
+   */
+  interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
+  /**
+   * Specifies the color for the `CondensedButton`.
+   */
+  color: PropTypes.oneOf(['primary', 'primary-inverse']),
+  /**
+   * 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,
+  /**
+   * Specify a mouse cursor to use when hovering over the button.
+   * The `pointer` cursor is used by default.
+   */
+  cursor: PropTypes.string,
+  /**
+   * Specifies an href attribute for the `CondensedButton`'s underlying html element.
+   */
+  href: PropTypes.string,
+  /**
+   * An icon, or function that returns an icon.
+   */
+  renderIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func])
+}
+
+const allowedProps: AllowedPropKeys = [
+  'as',
+  'children',
+  'color',
+  'cursor',
+  'elementRef',
+  'href',
+  'interaction',
+  'margin',
+  'renderIcon',
+  'size',
+  'type'
+]
+
+export type { CondensedButtonProps }
+export { propTypes, allowedProps }