@atlaskit/button
Version:
A button triggers an event or action. They let users know what will happen next.
176 lines (172 loc) • 5.09 kB
JavaScript
import _extends from "@babel/runtime/helpers/extends";
import React, { useCallback, useState } from 'react';
// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
import GlobalTheme from '@atlaskit/theme/components';
import ButtonBase from '../shared/button-base';
import getIsOnlySingleIcon from '../shared/get-is-only-single-icon';
import LoadingSpinner from '../shared/loading-spinner';
import Theme, { defaultThemeFn, getSpecifiers } from './theme';
function getInteractionState({
isDisabled = false,
isActive = false,
isFocus = false,
isHover = false,
isSelected = false,
isLoading = false
}) {
if (isDisabled) {
return 'disabled';
}
if (isSelected && isFocus) {
return 'focusSelected';
}
if (isSelected) {
return 'selected';
}
// not allowing active or focus style changes while loading
if (!isLoading && isActive) {
return 'active';
}
if (!isLoading && isHover) {
return 'hover';
}
if (isFocus) {
return 'focus';
}
return 'default';
}
const initial = {
isHover: false,
isActive: false,
isFocus: false
};
/**
* __Custom theme button__
*
* @deprecated Legacy buttons are deprecated and will be removed from `atlaskit/button` in an upcoming major release. Please use the new Button components from `@atlaskit/button/new`
*
* Please refer to the [migration guide](https://atlassian.design/components/button/button-legacy/migration-guide) for further details.
*
* A custom theme button. Avoid using this component. It exists for those already using custom theming, which is hard to use and has performance issues.
*
* - [Examples](https://atlassian.design/components/button/examples#custom-theme-button)
*/
const CustomThemeButton = /*#__PURE__*/React.memo( /*#__PURE__*/React.forwardRef(function CustomThemeButton({
// Calculate default props for use in custom themes
appearance = 'default',
autoFocus = false,
isDisabled = false,
isSelected = false,
shouldFitContainer = false,
spacing = 'default',
isLoading = false,
onMouseEnter: providedOnMouseEnter,
onMouseLeave: providedOnMouseLeave,
onMouseDown: providedOnMouseDown,
onMouseUp: providedOnMouseUp,
onFocus: providedOnFocus,
onBlur: providedOnBlur,
theme = defaultThemeFn,
...rest
}, ref) {
// TODO is there a nicer way to do this?
// Add default props back into object for spreading
const restProps = {
appearance,
autoFocus,
isDisabled,
isSelected,
shouldFitContainer,
spacing,
...rest
};
const [state, setState] = useState(initial);
const onMouseEnter = useCallback(event => {
setState(current => ({
...current,
isHover: true
}));
if (providedOnMouseEnter) {
providedOnMouseEnter(event);
}
}, [providedOnMouseEnter]);
const onMouseLeave = useCallback(event => {
setState(current => ({
...current,
isHover: false,
isActive: false
}));
if (providedOnMouseLeave) {
providedOnMouseLeave(event);
}
}, [providedOnMouseLeave]);
const onMouseDown = useCallback(event => {
setState(current => ({
...current,
isActive: true
}));
if (providedOnMouseDown) {
providedOnMouseDown(event);
}
}, [providedOnMouseDown]);
const onMouseUp = useCallback(event => {
setState(current => ({
...current,
isActive: false
}));
if (providedOnMouseUp) {
providedOnMouseUp(event);
}
}, [providedOnMouseUp]);
const onFocus = useCallback(event => {
setState(current => ({
...current,
isFocus: true
}));
if (providedOnFocus) {
providedOnFocus(event);
}
}, [providedOnFocus]);
const onBlur = useCallback(event => {
setState(current => ({
...current,
isFocus: false
}));
if (providedOnBlur) {
providedOnBlur(event);
}
}, [providedOnBlur]);
return /*#__PURE__*/React.createElement(Theme.Provider, {
value: theme
}, /*#__PURE__*/React.createElement(GlobalTheme.Consumer, null, ({
mode
}) => /*#__PURE__*/React.createElement(Theme.Consumer, _extends({
mode: mode,
state: getInteractionState({
...state,
isLoading,
isSelected: restProps.isSelected,
isDisabled: restProps.isDisabled
}),
iconIsOnlyChild: getIsOnlySingleIcon(restProps),
isLoading: isLoading
}, restProps), ({
buttonStyles
}) => /*#__PURE__*/React.createElement(ButtonBase, _extends({}, restProps, {
ref: ref,
overlay: isLoading ? /*#__PURE__*/React.createElement(LoadingSpinner, restProps) : null
// No need to render aria-disabled when it is false
,
"aria-disabled": isLoading || restProps['aria-disabled'],
onMouseEnter: onMouseEnter,
onMouseLeave: onMouseLeave,
onMouseDown: onMouseDown,
onMouseUp: onMouseUp,
onFocus: onFocus,
onBlur: onBlur,
buttonCss: getSpecifiers(buttonStyles)
})))));
}));
// Tools including enzyme rely on components having a display name
CustomThemeButton.displayName = 'CustomThemeButton';
export default CustomThemeButton;