@spark-web/button 1.2.0 → 1.4.0

package/dist/spark-web-button.esm.js

@@ -4,13 +4,13 @@ import { Box } from '@spark-web/box';
 import { useComposedRefs } from '@spark-web/utils';
 import { forwardRef, useRef, useCallback, Children, isValidElement, cloneElement } from 'react';
 import { jsx, jsxs } from 'react/jsx-runtime';
+import _slicedToArray from '@babel/runtime/helpers/esm/slicedToArray';
+import { css } from '@emotion/css';
 import { useFocusRing, VisuallyHidden } from '@spark-web/a11y';
 import { Spinner } from '@spark-web/spinner';
 import { Text } from '@spark-web/text';
-import { css } from '@emotion/css';
 import { useTheme } from '@spark-web/theme';
 import { useLinkComponent } from '@spark-web/link';
-import { buildDataAttributes } from '@spark-web/utils/internal';
 import { forwardRefWithAs } from '@spark-web/utils/ts';
 
 var _excluded$2 = ["onClick", "disabled", "type"];
@@ -20,7 +20,7 @@ var BaseButton = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
       disabled = _ref$disabled === void 0 ? false : _ref$disabled,
       _ref$type = _ref.type,
       type = _ref$type === void 0 ? 'button' : _ref$type,
-      rest = _objectWithoutProperties(_ref, _excluded$2);
+      consumerProps = _objectWithoutProperties(_ref, _excluded$2);
 
   var internalRef = useRef(null);
   var composedRef = useComposedRefs(internalRef, forwardedRef);
@@ -38,11 +38,12 @@ var BaseButton = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
     var preventableClickHandler = getPreventableClickHandler(onClickProp, disabled);
     preventableClickHandler(event);
   }, [disabled, onClickProp]);
-  return /*#__PURE__*/jsx(Box, _objectSpread(_objectSpread({
-    as: "button"
-  }, rest), {}, {
+  return /*#__PURE__*/jsx(Box, _objectSpread(_objectSpread({}, consumerProps), {}, {
+    as: "button",
+    ref: composedRef // Hide aria-disabled attribute when button is not disabled
+    ,
+    "aria-disabled": disabled || undefined,
     onClick: onClick,
-    ref: composedRef,
     type: type
   }));
 });
@@ -62,39 +63,62 @@ function getPreventableClickHandler(onClick, disabled) {
   };
 }
 
+var highDisabledStyles = {
+  backgroundDisabled: 'disabled',
+  borderDisabled: 'fieldDisabled',
+  textToneDisabled: 'neutralInverted'
+};
+var highDisabledAltStyles = {
+  backgroundDisabled: 'neutral',
+  borderDisabled: 'standard',
+  textToneDisabled: 'placeholder'
+};
+var lowDisabledStyles = {
+  backgroundDisabled: 'inputDisabled',
+  textToneDisabled: 'disabled'
+};
+var lowDisabledAltStyles = {
+  backgroundDisabled: 'inputDisabled',
+  borderDisabled: 'fieldDisabled',
+  textToneDisabled: 'disabled'
+};
+var noneDisabledStyles = {
+  backgroundDisabled: 'neutral',
+  textToneDisabled: 'disabled'
+};
 var variants = {
   high: {
-    primary: {
+    primary: _objectSpread({
       background: 'primary',
       backgroundHover: 'primaryHover',
       backgroundActive: 'primaryActive'
-    },
-    secondary: {
+    }, highDisabledStyles),
+    secondary: _objectSpread({
       background: 'secondary',
       backgroundHover: 'secondaryHover',
       backgroundActive: 'secondaryActive'
-    },
-    neutral: {
+    }, highDisabledStyles),
+    neutral: _objectSpread({
       background: 'neutral',
       border: 'field',
       backgroundHover: 'neutralHover',
       backgroundActive: 'neutralActive'
-    },
-    positive: {
+    }, highDisabledAltStyles),
+    positive: _objectSpread({
       background: 'positive',
       backgroundHover: 'positiveHover',
       backgroundActive: 'positiveActive'
-    },
-    critical: {
+    }, highDisabledStyles),
+    critical: _objectSpread({
       background: 'critical',
       backgroundHover: 'criticalHover',
       backgroundActive: 'criticalActive'
-    },
+    }, highDisabledStyles),
     caution: undefined,
     info: undefined
   },
   low: {
-    primary: {
+    primary: _objectSpread({
       background: 'surface',
       border: 'primary',
       borderWidth: 'large',
@@ -105,8 +129,8 @@ var variants = {
       backgroundActive: 'none',
       borderActive: 'primaryActive',
       textToneActive: 'primaryActive'
-    },
-    secondary: {
+    }, lowDisabledAltStyles),
+    secondary: _objectSpread({
       background: 'surface',
       border: 'secondary',
       borderWidth: 'large',
@@ -117,76 +141,76 @@ var variants = {
       backgroundActive: 'none',
       borderActive: 'secondaryActive',
       textToneActive: 'secondaryActive'
-    },
-    neutral: {
+    }, lowDisabledAltStyles),
+    neutral: _objectSpread({
       background: 'neutralLow',
       backgroundHover: 'neutralLowHover',
       backgroundActive: 'neutralLowActive'
-    },
-    positive: {
+    }, lowDisabledStyles),
+    positive: _objectSpread({
       background: 'positiveLow',
       backgroundHover: 'positiveLowHover',
       backgroundActive: 'positiveLowActive'
-    },
-    caution: {
+    }, lowDisabledStyles),
+    caution: _objectSpread({
       background: 'cautionLow',
       backgroundHover: 'cautionLowHover',
       backgroundActive: 'cautionLowActive'
-    },
-    critical: {
+    }, lowDisabledStyles),
+    critical: _objectSpread({
       background: 'criticalLow',
       backgroundHover: 'criticalLowHover',
       backgroundActive: 'criticalLowActive'
-    },
-    info: {
+    }, lowDisabledStyles),
+    info: _objectSpread({
       background: 'infoLow',
       backgroundHover: 'infoLowHover',
       backgroundActive: 'infoLowActive'
-    }
+    }, lowDisabledStyles)
   },
   none: {
-    primary: {
+    primary: _objectSpread({
       background: 'surface',
       textTone: 'primaryActive',
       backgroundHover: 'primaryLowHover',
       backgroundActive: 'primaryLowActive'
-    },
-    secondary: {
+    }, noneDisabledStyles),
+    secondary: _objectSpread({
       background: 'surface',
       textTone: 'secondaryActive',
       backgroundHover: 'secondaryLowHover',
       backgroundActive: 'secondaryLowActive'
-    },
-    neutral: {
+    }, noneDisabledStyles),
+    neutral: _objectSpread({
       background: 'surface',
       textTone: 'neutral',
       backgroundHover: 'neutralLowHover',
       backgroundActive: 'neutralLowActive'
-    },
-    positive: {
+    }, noneDisabledStyles),
+    positive: _objectSpread({
       background: 'surface',
       textTone: 'positive',
       backgroundHover: 'positiveLowHover',
       backgroundActive: 'positiveLowActive'
-    },
-    caution: {
+    }, noneDisabledStyles),
+    caution: _objectSpread({
       background: 'surface',
       textTone: 'caution',
       backgroundHover: 'cautionLowHover',
       backgroundActive: 'cautionLowActive'
-    },
-    critical: {
+    }, noneDisabledStyles),
+    critical: _objectSpread({
       background: 'surface',
       textTone: 'critical',
       backgroundHover: 'criticalLowHover',
       backgroundActive: 'criticalLowActive'
-    },
-    info: {
+    }, noneDisabledStyles),
+    info: _objectSpread({
       background: 'surface',
       textTone: 'info',
       backgroundHover: 'infoLowHover',
       backgroundActive: 'infoLowActive'
-    }
+    }, noneDisabledStyles)
   }
 };
 var mapTokens = {
@@ -212,7 +236,7 @@ var resolveButtonChildren = function resolveButtonChildren(_ref) {
       tone = _ref.tone;
   var variant = variants[prominence][tone];
   return Children.map(children, function (child) {
-    if (typeof child === 'string') {
+    if (typeof child === 'string' || typeof child === 'number') {
       return /*#__PURE__*/jsx(HiddenWhenLoading, {
         isLoading: isLoading,
         children: /*#__PURE__*/jsx(Text, {
@@ -259,6 +283,15 @@ function HiddenWhenLoading(_ref2) {
   });
 }
 
+/**
+ * useButtonStyles
+ *
+ * Custom hook for styling buttons and certain links.
+ * Returns a tuple where the first item is an object of props to spread onto the
+ * underlying `Box` component, and the second item is a CSS object that can be
+ * passed to Emotion's `css` function.
+ */
+
 function useButtonStyles(_ref) {
   var iconOnly = _ref.iconOnly,
       prominence = _ref.prominence,
@@ -268,14 +301,17 @@ function useButtonStyles(_ref) {
   var focusRingStyles = useFocusRing({
     tone: tone
   });
+  var disabledFocusRingStyles = useFocusRing({
+    tone: 'disabled'
+  });
   var variant = variants[prominence][tone];
   var isLarge = size === 'large';
-  var transitionColours = {
-    transitionProperty: 'color, background-color, border-color, text-decoration-color',
-    transitionTimingFunction: 'cubic-bezier(0.02, 1.505, 0.745, 1.235)',
+  var transitionColors = {
+    transitionProperty: 'color, background-color, border-color, text-decoration-color, fill, stroke, opacity, box-shadow, transform, filter, backdrop-filter',
+    transitionTimingFunction: theme.animation.standard.easing,
     transitionDuration: "".concat(theme.animation.standard.duration, "ms")
   };
-  var buttonStyleProps = {
+  return [{
     alignItems: 'center',
     background: variant === null || variant === void 0 ? void 0 : variant.background,
     border: variant === null || variant === void 0 ? void 0 : variant.border,
@@ -288,32 +324,44 @@ function useButtonStyles(_ref) {
     justifyContent: 'center',
     paddingX: iconOnly ? undefined : mapTokens.spacing[size],
     position: 'relative',
-    width: iconOnly ? mapTokens.size[size] : undefined,
-    // interactions styles
-    className: css(_objectSpread(_objectSpread({}, transitionColours), {}, {
-      '&:hover': {
+    width: iconOnly ? mapTokens.size[size] : undefined
+  }, _objectSpread(_objectSpread({}, transitionColors), {}, {
+    // Styles for buttons that aren't disabled.
+    // Using the :not() pseudo-class so we don't have to undo the styles when
+    // the button is disabled.
+    '&:not([aria-disabled=true])': {
+      ':hover': {
         borderColor: variant !== null && variant !== void 0 && variant.borderHover ? theme.border.color[variant.borderHover] : undefined,
         backgroundColor: variant !== null && variant !== void 0 && variant.backgroundHover ? theme.backgroundInteractions[variant.backgroundHover] : undefined,
         // Style button text when hovering
-        '> *': _objectSpread(_objectSpread({}, transitionColours), {}, {
+        '> *': _objectSpread(_objectSpread({}, transitionColors), {}, {
           color: variant !== null && variant !== void 0 && variant.textToneHover ? theme.color.foreground[variant.textToneHover] : undefined,
           stroke: variant !== null && variant !== void 0 && variant.textToneHover ? theme.color.foreground[variant.textToneHover] : undefined
         })
       },
-      '&:active': {
+      ':active': {
         borderColor: variant !== null && variant !== void 0 && variant.borderActive ? theme.border.color[variant.borderActive] : undefined,
         backgroundColor: variant !== null && variant !== void 0 && variant.backgroundActive ? theme.backgroundInteractions[variant === null || variant === void 0 ? void 0 : variant.backgroundActive] : undefined,
         transform: 'scale(0.98)',
         // Style button text when it's active
-        '> *': _objectSpread(_objectSpread({}, transitionColours), {}, {
+        '> *': _objectSpread(_objectSpread({}, transitionColors), {}, {
           color: variant !== null && variant !== void 0 && variant.textToneActive ? theme.color.foreground[variant.textToneActive] : undefined,
           stroke: variant !== null && variant !== void 0 && variant.textToneActive ? theme.color.foreground[variant.textToneActive] : undefined
         })
       },
       ':focus': focusRingStyles
-    }))
-  };
-  return buttonStyleProps;
+    },
+    '&[aria-disabled=true]': {
+      backgroundColor: variant !== null && variant !== void 0 && variant.backgroundDisabled ? theme.color.background[variant === null || variant === void 0 ? void 0 : variant.backgroundDisabled] : undefined,
+      borderColor: variant !== null && variant !== void 0 && variant.borderDisabled ? theme.border.color[variant.borderDisabled] : undefined,
+      cursor: 'default',
+      '*': {
+        color: variant !== null && variant !== void 0 && variant.textToneDisabled ? theme.color.foreground[variant.textToneDisabled] : undefined,
+        stroke: variant !== null && variant !== void 0 && variant.textToneDisabled ? theme.color.foreground[variant.textToneDisabled] : undefined
+      },
+      ':focus': disabledFocusRingStyles
+    }
+  })];
 }
 
 var _excluded$1 = ["aria-controls", "aria-describedby", "aria-expanded", "data", "disabled", "id", "loading", "onClick", "prominence", "size", "tone", "type"];
@@ -342,21 +390,26 @@ var Button = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
       props = _objectWithoutProperties(_ref, _excluded$1);
 
   var iconOnly = Boolean(props.label);
-  var buttonStyleProps = useButtonStyles({
+
+  var _useButtonStyles = useButtonStyles({
     iconOnly: iconOnly,
     size: size,
     tone: tone,
     prominence: prominence
-  });
+  }),
+      _useButtonStyles2 = _slicedToArray(_useButtonStyles, 2),
+      boxProps = _useButtonStyles2[0],
+      buttonStyles = _useButtonStyles2[1];
+
   var isDisabled = disabled || loading;
   var isLoading = loading && !disabled;
   var variant = variants[prominence][tone];
-  return /*#__PURE__*/jsxs(BaseButton, _objectSpread(_objectSpread({}, buttonStyleProps), {}, {
+  return /*#__PURE__*/jsxs(BaseButton, _objectSpread(_objectSpread({}, boxProps), {}, {
     "aria-controls": ariaControls,
     "aria-describedby": ariaDescribedBy,
-    "aria-disabled": isDisabled,
     "aria-expanded": ariaExpanded,
     "aria-label": props.label,
+    className: css(buttonStyles),
     data: data,
     disabled: isDisabled,
     id: id,
@@ -399,7 +452,7 @@ function Loading(_ref2) {
 var _excluded = ["data", "href", "id", "prominence", "size", "tone"];
 
 /** The appearance of a `Button`, with the semantics of a link. */
-var ButtonLink = forwardRefWithAs(function (_ref, ref) {
+var ButtonLink = forwardRefWithAs(function (_ref, forwardedRef) {
   var data = _ref.data,
       href = _ref.href,
       id = _ref.id,
@@ -409,25 +462,31 @@ var ButtonLink = forwardRefWithAs(function (_ref, ref) {
       size = _ref$size === void 0 ? 'medium' : _ref$size,
       _ref$tone = _ref.tone,
       tone = _ref$tone === void 0 ? 'primary' : _ref$tone,
-      props = _objectWithoutProperties(_ref, _excluded);
+      consumerProps = _objectWithoutProperties(_ref, _excluded);
 
-  var LinkComponent = useLinkComponent(ref);
-  var iconOnly = Boolean(props.label);
-  var buttonStyleProps = useButtonStyles({
+  var LinkComponent = useLinkComponent(forwardedRef);
+  var iconOnly = Boolean(consumerProps.label);
+
+  var _useButtonStyles = useButtonStyles({
     iconOnly: iconOnly,
     prominence: prominence,
     size: size,
     tone: tone
-  });
-  return /*#__PURE__*/jsx(Box, _objectSpread(_objectSpread(_objectSpread({
-    "aria-label": props.label,
+  }),
+      _useButtonStyles2 = _slicedToArray(_useButtonStyles, 2),
+      boxProps = _useButtonStyles2[0],
+      buttonStyles = _useButtonStyles2[1];
+
+  return /*#__PURE__*/jsx(Box, _objectSpread(_objectSpread({}, boxProps), {}, {
+    "aria-label": consumerProps.label,
     as: LinkComponent,
     asElement: "a",
-    id: id,
+    className: css(buttonStyles),
+    data: data,
     href: href,
-    ref: ref
-  }, buttonStyleProps), data ? buildDataAttributes(data) : undefined), {}, {
-    children: resolveButtonChildren(_objectSpread(_objectSpread({}, props), {}, {
+    id: id,
+    ref: forwardedRef,
+    children: resolveButtonChildren(_objectSpread(_objectSpread({}, consumerProps), {}, {
       isLoading: false,
       prominence: prominence,
       size: size,
@@ -436,4 +495,4 @@ var ButtonLink = forwardRefWithAs(function (_ref, ref) {
   }));
 });
 
-export { BaseButton, Button, ButtonLink };
+export { BaseButton, Button, ButtonLink, useButtonStyles };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spark-web/button",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "license": "MIT",
   "main": "dist/spark-web-button.cjs.js",
   "module": "dist/spark-web-button.esm.js",
@@ -8,16 +8,16 @@
     "dist"
   ],
   "dependencies": {
-    "@babel/runtime": "^7.18.3",
+    "@babel/runtime": "^7.18.9",
     "@emotion/css": "^11.9.0",
-    "@spark-web/a11y": "^1.1.0",
-    "@spark-web/box": "^1.0.6",
-    "@spark-web/icon": "^1.1.4",
-    "@spark-web/link": "^1.0.6",
-    "@spark-web/spinner": "^1.0.4",
-    "@spark-web/text": "^1.0.6",
-    "@spark-web/theme": "^3.0.2",
-    "@spark-web/utils": "^1.1.5"
+    "@spark-web/a11y": "^1.2.0",
+    "@spark-web/box": "^1.0.7",
+    "@spark-web/icon": "^1.1.5",
+    "@spark-web/link": "^1.0.7",
+    "@spark-web/spinner": "^1.0.5",
+    "@spark-web/text": "^1.0.7",
+    "@spark-web/theme": "^3.0.4",
+    "@spark-web/utils": "^1.2.0"
   },
   "devDependencies": {
     "@types/react": "^17.0.12",