@instructure/ui-buttons 8.8.1-snapshot.7 → 8.9.1-snapshot.2

package/src/IconButton/index.tsx

@@ -23,17 +23,18 @@
  */
 
 import React, { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { testable } from '@instructure/ui-testable'
 import { passthroughProps } from '@instructure/ui-react-utils'
 import { ScreenReaderContent } from '@instructure/ui-a11y-content'
 
-import { withStyle, ThemeablePropTypes } from '@instructure/emotion'
+import { withStyle } from '@instructure/emotion'
 
 import generateComponentTheme from './theme'
 import { BaseButton } from '../BaseButton'
-import { IconButtonProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { IconButtonProps } from './props'
 
 /**
 ---
@@ -47,100 +48,22 @@ category: components
 class IconButton extends Component<IconButtonProps> {
   static readonly componentId = 'IconButton'
 
-  static propTypes = {
-    /**
-     * An icon, or function returning an icon (identical to the `renderIcon` prop).
-     */
-    children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-    /**
-     * An icon, or function that returns an icon (identical to the `children` prop).
-     */
-    renderIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-    /**
-     * An accessible label for the `IconButton`.
-     */
-    screenReaderLabel: PropTypes.string.isRequired,
-    /**
-     * Specifies the type of the `IconButton`'s underlying html element.
-     */
-    type: PropTypes.oneOf(['button', 'submit', 'reset']),
-    /**
-     * The size of the `IconButton`
-     */
-    size: PropTypes.oneOf(['small', 'medium', 'large']),
-    /**
-     * Provides a reference to the `IconButton`'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 `IconButton` is enabled, disabled, or readonly.
-     */
-    interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
-    /**
-     * Specifies the color for the `IconButton`.
-     */
-    color: PropTypes.oneOf([
-      'primary',
-      'primary-inverse',
-      'secondary',
-      'success',
-      'danger'
-    ]),
-    /**
-     * Override the `Button`'s default focus outline color.
-     */
-    focusColor: PropTypes.oneOf(['info', 'inverse']),
-    /**
-     * Specifies if the `IconButton` shape should be a circle or rectangle.
-     */
-    shape: PropTypes.oneOf(['rectangle', 'circle']),
-    /**
-     * Specifies if the `IconButton` should render with a solid background. When false, the background is transparent.
-     */
-    withBackground: PropTypes.bool,
-    /**
-     * Specifies if the `IconButton` should render with a border.
-     */
-    withBorder: PropTypes.bool,
-    /**
-     * 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 `IconButton`'s underlying html element.
-     */
-    href: PropTypes.string
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     children: null,
-    renderIcon: undefined,
     type: 'button',
     size: 'medium',
     // @ts-expect-error ts-migrate(6133) FIXME: 'el' is declared but its value is never read.
     elementRef: (el) => {},
     as: 'button',
     // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
-    interaction: undefined,
     color: 'secondary',
-    focusColor: undefined,
     shape: 'rectangle',
     withBackground: true,
     withBorder: true,
     margin: '0',
-    cursor: 'pointer',
-    href: undefined
+    cursor: 'pointer'
   }
 
   _baseButton = null

package/src/IconButton/props.ts

@@ -0,0 +1,154 @@
+/*
+ * 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 IconButtonOwnProps = {
+  children?: React.ReactNode | ((...args: any[]) => React.ReactNode)
+  renderIcon?: React.ReactNode | ((...args: any[]) => any)
+  screenReaderLabel: string
+  type?: 'button' | 'submit' | 'reset'
+  size?: 'small' | 'medium' | 'large'
+  elementRef?: (...args: any[]) => any
+  as?: AsElementType
+  interaction?: 'enabled' | 'disabled' | 'readonly'
+  color?: 'primary' | 'primary-inverse' | 'secondary' | 'success' | 'danger'
+  focusColor?: 'info' | 'inverse'
+  shape?: 'rectangle' | 'circle'
+  withBackground?: boolean
+  withBorder?: boolean
+  margin?: Spacing
+  cursor?: string
+  href?: string
+}
+
+type PropKeys = keyof IconButtonOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type IconButtonProps = IconButtonOwnProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * An icon, or function returning an icon (identical to the `renderIcon` prop).
+   */
+  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+  /**
+   * An icon, or function that returns an icon (identical to the `children` prop).
+   */
+  renderIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+  /**
+   * An accessible label for the `IconButton`.
+   */
+  screenReaderLabel: PropTypes.string.isRequired,
+  /**
+   * Specifies the type of the `IconButton`'s underlying html element.
+   */
+  type: PropTypes.oneOf(['button', 'submit', 'reset']),
+  /**
+   * The size of the `IconButton`
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Provides a reference to the `IconButton`'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 `IconButton` is enabled, disabled, or readonly.
+   */
+  interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
+  /**
+   * Specifies the color for the `IconButton`.
+   */
+  color: PropTypes.oneOf([
+    'primary',
+    'primary-inverse',
+    'secondary',
+    'success',
+    'danger'
+  ]),
+  /**
+   * Override the `Button`'s default focus outline color.
+   */
+  focusColor: PropTypes.oneOf(['info', 'inverse']),
+  /**
+   * Specifies if the `IconButton` shape should be a circle or rectangle.
+   */
+  shape: PropTypes.oneOf(['rectangle', 'circle']),
+  /**
+   * Specifies if the `IconButton` should render with a solid background. When false, the background is transparent.
+   */
+  withBackground: PropTypes.bool,
+  /**
+   * Specifies if the `IconButton` should render with a border.
+   */
+  withBorder: PropTypes.bool,
+  /**
+   * 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 `IconButton`'s underlying html element.
+   */
+  href: PropTypes.string
+}
+
+const allowedProps: AllowedPropKeys = [
+  'as',
+  'children',
+  'color',
+  'cursor',
+  'elementRef',
+  'focusColor',
+  'href',
+  'interaction',
+  'margin',
+  'renderIcon',
+  'screenReaderLabel',
+  'shape',
+  'size',
+  'type',
+  'withBackground',
+  'withBorder'
+]
+
+export type { IconButtonProps }
+export { propTypes, allowedProps }

package/src/ToggleButton/index.tsx

@@ -23,16 +23,16 @@
  */
 
 import React, { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { testable } from '@instructure/ui-testable'
-import { PositionPropTypes } from '@instructure/ui-position'
 
 import { callRenderProp, passthroughProps } from '@instructure/ui-react-utils'
 
 import { Tooltip } from '@instructure/ui-tooltip'
 import { IconButton } from '../IconButton'
-import { ToggleButtonProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { ToggleButtonProps } from './props'
 
 /**
 ---
@@ -44,81 +44,18 @@ category: components
 class ToggleButton extends Component<ToggleButtonProps> {
   static readonly componentId = 'ToggleButton'
 
-  static propTypes = {
-    /**
-     * Text to output only to screen readers
-     */
-    screenReaderLabel: PropTypes.string.isRequired,
-    /**
-     * Text to render in the tooltip shown on hover/focus
-     */
-    renderTooltipContent: PropTypes.oneOfType([PropTypes.node, PropTypes.func])
-      .isRequired,
-    /**
-     * An icon or function that returns an icon
-     */
-    renderIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func])
-      .isRequired,
-    /**
-     * Toggles the `aria-pressed` attribute on the button (`true` if `pressed`; `false` if `unpressed`)
-     */
-    status: PropTypes.oneOf(['pressed', 'unpressed']).isRequired,
-    /**
-     * The element to render as the component root; `button` by default
-     */
-    as: PropTypes.elementType,
-    /**
-     * Specifies if interaction with `ToggleButton` is `enabled`, `disabled`, or `readonly`
-     */
-    interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
-    /**
-     * The size of the `ToggleButton`
-     */
-    size: PropTypes.oneOf(['small', 'medium', 'large']),
-    /**
-     * Provides a reference to `ToggleButton`'s underlying HTML element
-     */
-    elementRef: PropTypes.func,
-    /**
-     * Callback fired when the `ToggleButton` is clicked
-     */
-    onClick: PropTypes.func,
-    /**
-     * The color in which to display the icon
-     */
-    color: PropTypes.string,
-    /**
-     * By default, the tooltip will show on hover/focus. Use this prop if you need to override that behavior.
-     */
-    isShowingTooltip: PropTypes.bool,
-    /**
-     * An element or a function returning an element to use as the mount node
-     */
-    mountNode: PositionPropTypes.mountNode,
-    /**
-     * The placement of the tooltip in relation to the button
-     */
-    placement: PositionPropTypes.placement,
-    /**
-     * The parent in which to constrain the tooltip.
-     * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
-     * or a function returning an element.
-     */
-    constrain: PositionPropTypes.constrain
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     size: 'medium',
     as: 'button',
     // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
-    interaction: undefined,
     // @ts-expect-error ts-migrate(6133) FIXME: 'el' is declared but its value is never read.
     elementRef: (el) => {},
     renderIcon: () => {},
     onClick: () => {},
     mountNode: null,
     color: 'secondary',
-    isShowingTooltip: undefined,
     placement: 'top center',
     constrain: 'window'
   }

package/src/ToggleButton/props.ts

@@ -0,0 +1,140 @@
+/*
+ * 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 { PositionPropTypes } from '@instructure/ui-position'
+
+import type { AsElementType, PropValidators } from '@instructure/shared-types'
+import type {
+  PlacementPropValues,
+  PositionConstraint,
+  PositionMountNode
+} from '@instructure/ui-position'
+
+type ToggleButtonOwnProps = {
+  screenReaderLabel: string
+  renderTooltipContent: React.ReactNode | ((...args: any[]) => any)
+  renderIcon: React.ReactNode | ((...args: any[]) => any)
+  status: 'pressed' | 'unpressed'
+  as?: AsElementType
+  interaction?: 'enabled' | 'disabled' | 'readonly'
+  size?: 'small' | 'medium' | 'large'
+  elementRef?: (...args: any[]) => any
+  onClick?: (...args: any[]) => any
+  color?: string
+  isShowingTooltip?: boolean
+  mountNode?: PositionMountNode
+  placement?: PlacementPropValues
+  constrain?: PositionConstraint
+}
+
+type PropKeys = keyof ToggleButtonOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type ToggleButtonProps = ToggleButtonOwnProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * Text to output only to screen readers
+   */
+  screenReaderLabel: PropTypes.string.isRequired,
+  /**
+   * Text to render in the tooltip shown on hover/focus
+   */
+  renderTooltipContent: PropTypes.oneOfType([PropTypes.node, PropTypes.func])
+    .isRequired,
+  /**
+   * An icon or function that returns an icon
+   */
+  renderIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
+  /**
+   * Toggles the `aria-pressed` attribute on the button (`true` if `pressed`; `false` if `unpressed`)
+   */
+  status: PropTypes.oneOf(['pressed', 'unpressed']).isRequired,
+  /**
+   * The element to render as the component root; `button` by default
+   */
+  as: PropTypes.elementType,
+  /**
+   * Specifies if interaction with `ToggleButton` is `enabled`, `disabled`, or `readonly`
+   */
+  interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
+  /**
+   * The size of the `ToggleButton`
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Provides a reference to `ToggleButton`'s underlying HTML element
+   */
+  elementRef: PropTypes.func,
+  /**
+   * Callback fired when the `ToggleButton` is clicked
+   */
+  onClick: PropTypes.func,
+  /**
+   * The color in which to display the icon
+   */
+  color: PropTypes.string,
+  /**
+   * By default, the tooltip will show on hover/focus. Use this prop if you need to override that behavior.
+   */
+  isShowingTooltip: PropTypes.bool,
+  /**
+   * An element or a function returning an element to use as the mount node
+   */
+  mountNode: PositionPropTypes.mountNode,
+  /**
+   * The placement of the tooltip in relation to the button
+   */
+  placement: PositionPropTypes.placement,
+  /**
+   * The parent in which to constrain the tooltip.
+   * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+   * or a function returning an element.
+   */
+  constrain: PositionPropTypes.constrain
+}
+
+const allowedProps: AllowedPropKeys = [
+  'as',
+  'color',
+  'constrain',
+  'elementRef',
+  'interaction',
+  'isShowingTooltip',
+  'mountNode',
+  'onClick',
+  'placement',
+  'renderIcon',
+  'renderTooltipContent',
+  'screenReaderLabel',
+  'size',
+  'status'
+]
+
+export type { ToggleButtonProps }
+export { propTypes, allowedProps }