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

package/src/BaseButton/props.ts

@@ -0,0 +1,192 @@
+/*
+ * 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 { InteractionType } from '@instructure/ui-react-utils'
+import type { Spacing, WithStyleProps } from '@instructure/emotion'
+import type { AsElementType, PropValidators } from '@instructure/shared-types'
+
+type BaseButtonOwnProps = {
+  children?: React.ReactNode
+  type?: 'button' | 'submit' | 'reset'
+  size?: 'small' | 'medium' | 'large'
+  elementRef?: (...args: any[]) => any
+  as?: AsElementType
+  interaction?: InteractionType
+  color?: 'primary' | 'primary-inverse' | 'secondary' | 'success' | 'danger'
+  focusColor?: 'info' | 'inverse'
+  display?: 'inline-block' | 'block'
+  textAlign?: 'start' | 'center'
+  shape?: 'rectangle' | 'circle'
+  withBackground?: boolean
+  withBorder?: boolean
+  isCondensed?: boolean
+  margin?: Spacing
+  cursor?: string
+  href?: string
+  onClick?: (...args: any[]) => any
+  onKeyDown?: (...args: any[]) => any
+  renderIcon?: React.ReactNode | ((...args: any[]) => any)
+  tabIndex?: number | string
+}
+
+type BaseButtonStyleProps = {
+  isDisabled: boolean
+  hasOnlyIconVisible: boolean
+}
+
+type PropKeys = keyof BaseButtonOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type BaseButtonProps = BaseButtonOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * Specifies the `Button` children.
+   */
+  children: PropTypes.node,
+  /**
+   * Specifies the type of the `Button`'s underlying html element.
+   */
+  type: PropTypes.oneOf(['button', 'submit', 'reset']),
+  /**
+   * The size of the `Button`
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Provides a reference to the `Button`'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 `Button` is enabled, disabled, or readonly.
+   */
+  interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
+  /**
+   * Specifies the color for the `Button`.
+   */
+  color: PropTypes.oneOf([
+    'primary',
+    'primary-inverse',
+    'secondary',
+    'success',
+    'danger'
+  ]),
+  /**
+   * Override the `Button`'s default focus outline color.
+   */
+  focusColor: PropTypes.oneOf(['info', 'inverse']),
+  /**
+   * The `Button` display property. When set to `inline-block`, the `Button` displays inline with other elements.
+   * When set to block, the `Button` expands to fill the width of the container.
+   */
+  display: PropTypes.oneOf(['inline-block', 'block']),
+  /**
+   * Sets the alignment of the `Button` children and/or icon.
+   */
+  textAlign: PropTypes.oneOf(['start', 'center']),
+  /**
+   * Specifies if the `Button` shape should be a circle or rectangle.
+   */
+  shape: PropTypes.oneOf(['rectangle', 'circle']),
+  /**
+   * Specifies if the `Button` should render with a solid background. When false, the background is transparent.
+   */
+  withBackground: PropTypes.bool,
+  /**
+   * Specifies if the `Button` should render with a border.
+   */
+  withBorder: PropTypes.bool,
+  /**
+   * Designates if the `Button` should render without padding. This option should only be set when `withBorder` and
+   * `withBackground` are also set to false.
+   */
+  isCondensed: 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 `Button`'s underlying html element.
+   */
+  href: PropTypes.string,
+  /**
+   * Callback fired when the `Button` is clicked.
+   */
+  onClick: PropTypes.func,
+  /**
+   * Callback fired when the `Button` receives a keydown event.
+   */
+  onKeyDown: PropTypes.func,
+  /**
+   * An icon, or function that returns an icon.
+   */
+  renderIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+  /**
+   * Specifies the tabindex of the `Button`.
+   */
+  tabIndex: PropTypes.oneOfType([PropTypes.number, PropTypes.string])
+}
+
+const allowedProps: AllowedPropKeys = [
+  'as',
+  'children',
+  'color',
+  'cursor',
+  'display',
+  'elementRef',
+  'focusColor',
+  'href',
+  'interaction',
+  'isCondensed',
+  'margin',
+  'onClick',
+  'onKeyDown',
+  'renderIcon',
+  'shape',
+  'size',
+  'tabIndex',
+  'textAlign',
+  'type',
+  'withBackground',
+  'withBorder'
+]
+
+export type { BaseButtonProps, BaseButtonStyleProps }
+export { propTypes, allowedProps }

package/src/BaseButton/styles.ts

@@ -23,7 +23,7 @@
  */
 
 import { BaseButtonTheme } from '@instructure/shared-types'
-import { BaseButtonProps, BaseButtonStyleProps } from './types'
+import { BaseButtonProps, BaseButtonStyleProps } from './props'
 
 /**
  * ---

package/src/BaseButton/theme.ts

@@ -23,7 +23,7 @@
  */
 
 import { alpha, darken } from '@instructure/ui-color-utils'
-import { Theme, ThemeSpecificStyle } from '@instructure/ui-themes'
+import type { Theme, ThemeSpecificStyle } from '@instructure/ui-themes'
 import { BaseButtonTheme } from '@instructure/shared-types'
 
 const activeShadow = 'inset 0 0 0.1875rem 0.0625rem'

package/src/Button/index.tsx

@@ -23,16 +23,17 @@
  */
 
 import React, { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { testable } from '@instructure/ui-testable'
 import { getInteraction, 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 { ButtonProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { ButtonProps } from './props'
 
 /**
 ---
@@ -45,79 +46,8 @@ category: components
 class Button extends Component<ButtonProps> {
   static readonly componentId = 'Button'
 
-  static propTypes = {
-    /**
-     * Specifies the `Button` children.
-     */
-    children: PropTypes.node,
-    /**
-     * Specifies the type of the `Button`'s underlying html element.
-     */
-    type: PropTypes.oneOf(['button', 'submit', 'reset']),
-    /**
-     * The size of the `Button`
-     */
-    size: PropTypes.oneOf(['small', 'medium', 'large']),
-    /**
-     * Provides a reference to the `Button`'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 `Button` is enabled, disabled, or readonly.
-     */
-    interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
-    /**
-     * Specifies the color for the `Button`.
-     */
-    color: PropTypes.oneOf([
-      'primary',
-      'primary-inverse',
-      'secondary',
-      'success',
-      'danger'
-    ]),
-    /**
-     * Override the `Button`'s default focus outline color.
-     */
-    focusColor: PropTypes.oneOf(['info', 'inverse']),
-    /**
-     * The `Button` display property. When set to `inline-block`, the `Button` displays inline with other elements.
-     * When set to block, the `Button` expands to fill the width of the container.
-     */
-    display: PropTypes.oneOf(['inline-block', 'block']),
-    /**
-     * Sets the alignment of the `Button` children and/or icon.
-     */
-    textAlign: PropTypes.oneOf(['start', 'center']),
-    /**
-     * Specifies if the `Button` should render with a solid background. When false, the background is transparent.
-     */
-    withBackground: 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 `Button`'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',
@@ -126,16 +56,12 @@ class Button extends Component<ButtonProps> {
     elementRef: (el) => {},
     as: 'button',
     // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
-    interaction: undefined,
     color: 'secondary',
-    focusColor: undefined,
     display: 'inline-block',
     textAlign: 'center',
     withBackground: true,
     margin: '0',
-    cursor: 'pointer',
-    href: undefined,
-    renderIcon: undefined
+    cursor: 'pointer'
   }
 
   _buttonComponent = null

package/src/Button/props.ts

@@ -0,0 +1,149 @@
+/*
+ * 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 ButtonOwnProps = {
+  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' | 'secondary' | 'success' | 'danger'
+  focusColor?: 'info' | 'inverse'
+  display?: 'inline-block' | 'block'
+  textAlign?: 'start' | 'center'
+  withBackground?: boolean
+  margin?: Spacing
+  cursor?: string
+  href?: string
+  renderIcon?: React.ReactNode | ((...args: any[]) => any)
+}
+
+type PropKeys = keyof ButtonOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type ButtonProps = ButtonOwnProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * Specifies the `Button` children.
+   */
+  children: PropTypes.node,
+  /**
+   * Specifies the type of the `Button`'s underlying html element.
+   */
+  type: PropTypes.oneOf(['button', 'submit', 'reset']),
+  /**
+   * The size of the `Button`
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Provides a reference to the `Button`'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 `Button` is enabled, disabled, or readonly.
+   */
+  interaction: PropTypes.oneOf(['enabled', 'disabled', 'readonly']),
+  /**
+   * Specifies the color for the `Button`.
+   */
+  color: PropTypes.oneOf([
+    'primary',
+    'primary-inverse',
+    'secondary',
+    'success',
+    'danger'
+  ]),
+  /**
+   * Override the `Button`'s default focus outline color.
+   */
+  focusColor: PropTypes.oneOf(['info', 'inverse']),
+  /**
+   * The `Button` display property. When set to `inline-block`, the `Button` displays inline with other elements.
+   * When set to block, the `Button` expands to fill the width of the container.
+   */
+  display: PropTypes.oneOf(['inline-block', 'block']),
+  /**
+   * Sets the alignment of the `Button` children and/or icon.
+   */
+  textAlign: PropTypes.oneOf(['start', 'center']),
+  /**
+   * Specifies if the `Button` should render with a solid background. When false, the background is transparent.
+   */
+  withBackground: 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 `Button`'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',
+  'display',
+  'elementRef',
+  'focusColor',
+  'href',
+  'interaction',
+  'margin',
+  'renderIcon',
+  'size',
+  'textAlign',
+  'type',
+  'withBackground'
+]
+
+export type { ButtonProps }
+export { propTypes, allowedProps }