@atlaskit/button 17.6.1 → 17.7.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/button
 
+## 17.7.0
+
+### Minor Changes
+
+- [#73843](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/73843) [`9a090e6e7733`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/9a090e6e7733) - The new icon button incorrectly supported `spacing="none"`. This release removes support for this, leaving `"default"` and `"compact"` as the only two options.
+
+  The icon button docs have also been updated to better reflect the intended use of the `label` prop instead of `aria-label`. The `label` prop is designed to abstract the technical implementation for accessibility requirements. The new icon button does not use the `aria-label` attribute under the hood, rather it relys on visually hidden text instead. This is done for accessibility reasons as `aria-label` is not always translated whereas visually hidden text will be.
+
+## 17.6.2
+
+### Patch Changes
+
+- [#77547](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/77547) [`cce378569da1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/cce378569da1) - Migration documentation for changing from old to new button components. Documentation-only change.
+
 ## 17.6.1
 
 ### Patch Changes

package/dist/cjs/old-button/shared/button-base.js

@@ -117,7 +117,7 @@ var _default = exports.default = /*#__PURE__*/_react.default.forwardRef(function
     action: 'clicked',
     componentName: 'button',
     packageName: "@atlaskit/button",
-    packageVersion: "0.0.0-development",
+    packageVersion: "17.7.0",
     analyticsData: analyticsContext
   });
 

package/dist/cjs/utils/spacing.js

@@ -3,6 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
-var spacing = ['default', 'compact', 'none'];
-var _default = exports.default = spacing;
+exports.iconButtonSpacing = exports.buttonSpacing = void 0;
+var buttonSpacing = exports.buttonSpacing = ['default', 'compact', 'none'];
+var iconButtonSpacing = exports.iconButtonSpacing = ['default', 'compact'];

package/dist/cjs/utils/variants.js

@@ -15,6 +15,7 @@ var _link = _interopRequireDefault(require("../new-button/variants/default/link"
 var _button2 = _interopRequireDefault(require("../new-button/variants/icon/button"));
 var _link2 = _interopRequireDefault(require("../new-button/variants/icon/link"));
 var _appearances = require("./appearances");
+var _spacing = require("./spacing");
 var _excluded = ["href", "children"],
   _excluded2 = ["icon", "label"],
   _excluded3 = ["href", "icon", "label"];
@@ -62,22 +63,26 @@ var variants = [{
   name: 'Button',
   Component: _button.default,
   elementType: HTMLButtonElement,
-  appearances: _appearances.buttonAppearances
+  appearances: _appearances.buttonAppearances,
+  spacing: _spacing.buttonSpacing
 }, {
   name: 'LinkButton',
   Component: LinkButtonRender,
   elementType: HTMLAnchorElement,
-  appearances: _appearances.linkButtonAppearances
+  appearances: _appearances.linkButtonAppearances,
+  spacing: _spacing.buttonSpacing
 }, {
   name: 'IconButton',
   Component: IconButtonRender,
   elementType: HTMLButtonElement,
-  appearances: _appearances.iconButtonAppearances
+  appearances: _appearances.iconButtonAppearances,
+  spacing: _spacing.iconButtonSpacing
 }, {
   name: 'LinkIconButton',
   Component: LinkIconButtonRender,
   elementType: HTMLAnchorElement,
-  appearances: _appearances.iconButtonAppearances
+  appearances: _appearances.iconButtonAppearances,
+  spacing: _spacing.iconButtonSpacing
 }];
 var defaultButtonVariants = exports.defaultButtonVariants = variants.filter(function (_ref4) {
   var name = _ref4.name;

package/dist/es2019/old-button/shared/button-base.js

@@ -102,7 +102,7 @@ export default /*#__PURE__*/React.forwardRef(function ButtonBase(props, ref) {
     action: 'clicked',
     componentName: 'button',
     packageName: "@atlaskit/button",
-    packageVersion: "0.0.0-development",
+    packageVersion: "17.7.0",
     analyticsData: analyticsContext
   });
 

package/dist/es2019/utils/spacing.js

@@ -1,2 +1,3 @@
-const spacing = ['default', 'compact', 'none'];
-export default spacing;
+const buttonSpacing = ['default', 'compact', 'none'];
+const iconButtonSpacing = ['default', 'compact'];
+export { buttonSpacing, iconButtonSpacing };

package/dist/es2019/utils/variants.js

@@ -6,6 +6,7 @@ import LinkButton from '../new-button/variants/default/link';
 import IconButton from '../new-button/variants/icon/button';
 import LinkIconButton from '../new-button/variants/icon/link';
 import { buttonAppearances, iconButtonAppearances, linkButtonAppearances } from './appearances';
+import { buttonSpacing, iconButtonSpacing } from './spacing';
 // Add required default props to variants
 const LinkButtonRender = /*#__PURE__*/forwardRef(({
   href = 'home',
@@ -39,22 +40,26 @@ const variants = [{
   name: 'Button',
   Component: Button,
   elementType: HTMLButtonElement,
-  appearances: buttonAppearances
+  appearances: buttonAppearances,
+  spacing: buttonSpacing
 }, {
   name: 'LinkButton',
   Component: LinkButtonRender,
   elementType: HTMLAnchorElement,
-  appearances: linkButtonAppearances
+  appearances: linkButtonAppearances,
+  spacing: buttonSpacing
 }, {
   name: 'IconButton',
   Component: IconButtonRender,
   elementType: HTMLButtonElement,
-  appearances: iconButtonAppearances
+  appearances: iconButtonAppearances,
+  spacing: iconButtonSpacing
 }, {
   name: 'LinkIconButton',
   Component: LinkIconButtonRender,
   elementType: HTMLAnchorElement,
-  appearances: iconButtonAppearances
+  appearances: iconButtonAppearances,
+  spacing: iconButtonSpacing
 }];
 export const defaultButtonVariants = variants.filter(({
   name

package/dist/esm/old-button/shared/button-base.js

@@ -108,7 +108,7 @@ export default /*#__PURE__*/React.forwardRef(function ButtonBase(props, ref) {
     action: 'clicked',
     componentName: 'button',
     packageName: "@atlaskit/button",
-    packageVersion: "0.0.0-development",
+    packageVersion: "17.7.0",
     analyticsData: analyticsContext
   });
 

package/dist/esm/utils/spacing.js

@@ -1,2 +1,3 @@
-var spacing = ['default', 'compact', 'none'];
-export default spacing;
+var buttonSpacing = ['default', 'compact', 'none'];
+var iconButtonSpacing = ['default', 'compact'];
+export { buttonSpacing, iconButtonSpacing };

package/dist/esm/utils/variants.js

@@ -10,6 +10,7 @@ import LinkButton from '../new-button/variants/default/link';
 import IconButton from '../new-button/variants/icon/button';
 import LinkIconButton from '../new-button/variants/icon/link';
 import { buttonAppearances, iconButtonAppearances, linkButtonAppearances } from './appearances';
+import { buttonSpacing, iconButtonSpacing } from './spacing';
 // Add required default props to variants
 var LinkButtonRender = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _ref$href = _ref.href,
@@ -52,22 +53,26 @@ var variants = [{
   name: 'Button',
   Component: Button,
   elementType: HTMLButtonElement,
-  appearances: buttonAppearances
+  appearances: buttonAppearances,
+  spacing: buttonSpacing
 }, {
   name: 'LinkButton',
   Component: LinkButtonRender,
   elementType: HTMLAnchorElement,
-  appearances: linkButtonAppearances
+  appearances: linkButtonAppearances,
+  spacing: buttonSpacing
 }, {
   name: 'IconButton',
   Component: IconButtonRender,
   elementType: HTMLButtonElement,
-  appearances: iconButtonAppearances
+  appearances: iconButtonAppearances,
+  spacing: iconButtonSpacing
 }, {
   name: 'LinkIconButton',
   Component: LinkIconButtonRender,
   elementType: HTMLAnchorElement,
-  appearances: iconButtonAppearances
+  appearances: iconButtonAppearances,
+  spacing: iconButtonSpacing
 }];
 export var defaultButtonVariants = variants.filter(function (_ref4) {
   var name = _ref4.name;

package/dist/types/new-button/variants/default/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { type IconProp, type IconSize } from '../types';
+import { type ButtonSpacing, type IconProp, type IconSize } from '../types';
 export type CommonDefaultButtonProps = {
     /**
      * Text content to be rendered in the button. Required so that screen readers always have an accessible label provided for the button.
@@ -27,4 +27,8 @@ export type CommonDefaultButtonProps = {
      * Option to fit button width to its parent width.
      */
     shouldFitContainer?: boolean;
+    /**
+     * Controls the amount of padding in the button.
+     */
+    spacing?: ButtonSpacing;
 };

package/dist/types/new-button/variants/icon/types.d.ts

@@ -1,4 +1,4 @@
-import { type IconButtonAppearance, type IconProp, type IconSize } from '../types';
+import { type IconButtonAppearance, type IconButtonSpacing, type IconProp, type IconSize } from '../types';
 export type CommonIconButtonProps = {
     /**
      * The button style variation.
@@ -17,6 +17,10 @@ export type CommonIconButtonProps = {
      * Set the shape of the icon, defaults to square with rounded corners.
      */
     shape?: 'default' | 'circle';
+    /**
+     * Controls the amount of padding in the button.
+     */
+    spacing?: IconButtonSpacing;
     /**
      * Set the size of the icon. `medium` is default, so it does not need to be specified.
      * This is UNSAFE as it will be removed in future in favor of a 100% bounded API.

package/dist/types/new-button/variants/shared/use-button-base.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { xcss } from '@atlaskit/primitives';
-import { type Appearance, type CommonButtonProps } from '../types';
+import { type Appearance, type CommonButtonProps, type Spacing } from '../types';
 export type ControlledEvents<TagName extends HTMLElement> = Pick<React.DOMAttributes<TagName>, 'onMouseDownCapture' | 'onMouseUpCapture' | 'onKeyDownCapture' | 'onKeyUpCapture' | 'onTouchStartCapture' | 'onTouchEndCapture' | 'onPointerDownCapture' | 'onPointerUpCapture' | 'onClickCapture'> & Pick<CommonButtonProps<TagName>, 'onClick'>;
 export type UseButtonBaseArgs<TagName extends HTMLElement> = {
     ref: React.Ref<TagName>;
@@ -15,7 +15,8 @@ export type UseButtonBaseArgs<TagName extends HTMLElement> = {
     shouldFitContainer?: boolean;
     appearance?: Appearance;
     children: React.ReactNode;
-} & Pick<CommonButtonProps<TagName>, 'analyticsContext' | 'autoFocus' | 'interactionName' | 'isDisabled' | 'isSelected' | 'overlay' | 'spacing'> & ControlledEvents<TagName>;
+    spacing?: Spacing;
+} & Pick<CommonButtonProps<TagName>, 'analyticsContext' | 'autoFocus' | 'interactionName' | 'isDisabled' | 'isSelected' | 'overlay'> & ControlledEvents<TagName>;
 export type UseButtonBaseReturn<TagName extends HTMLElement> = {
     xcss: ReturnType<typeof xcss>;
     ref(node: TagName | null): void;

package/dist/types/new-button/variants/types.d.ts

@@ -5,7 +5,9 @@ export type ButtonAppearance = 'default' | 'danger' | 'primary' | 'subtle' | 'wa
 export type LinkButtonAppearance = 'default' | 'danger' | 'link' | 'primary' | 'subtle' | 'subtle-link' | 'warning';
 export type IconButtonAppearance = 'default' | 'primary' | 'subtle';
 export type Appearance = ButtonAppearance | LinkButtonAppearance | IconButtonAppearance;
-export type Spacing = 'compact' | 'default' | 'none';
+export type ButtonSpacing = 'compact' | 'default' | 'none';
+export type IconButtonSpacing = 'compact' | 'default';
+export type Spacing = ButtonSpacing | IconButtonSpacing;
 export type IconProp = React.ComponentType<IconProps>;
 export type IconSize = 'small' | 'large' | 'xlarge';
 type Combine<First, Second> = Omit<First, keyof Second> & Second;
@@ -38,10 +40,6 @@ export type CommonButtonProps<TagName extends HTMLElement> = {
      * Handler to be called on focus.
      */
     onFocus?: React.FocusEventHandler<TagName>;
-    /**
-     * Controls the amount of padding in the button.
-     */
-    spacing?: Spacing;
     /**
      * A unique string that appears as data attribute `data-testid` in the rendered code, serving as a hook for automated tests.
      */

package/dist/types/utils/spacing.d.ts

@@ -1,3 +1,4 @@
 import { type Spacing } from '../new-button/variants/types';
-declare const spacing: Spacing[];
-export default spacing;
+declare const buttonSpacing: Spacing[];
+declare const iconButtonSpacing: Spacing[];
+export { buttonSpacing, iconButtonSpacing };

package/dist/types/utils/variants.d.ts

@@ -4,29 +4,34 @@ import { LinkButtonProps } from '../new-button/variants/default/link';
 import { type IconButtonProps } from '../new-button/variants/icon/button';
 import { type LinkIconButtonProps } from '../new-button/variants/icon/link';
 import { buttonAppearances, iconButtonAppearances, linkButtonAppearances } from './appearances';
+import { buttonSpacing, iconButtonSpacing } from './spacing';
 type DefaultButtonVariant = {
     name: 'Button';
     Component: typeof Button;
     elementType: typeof HTMLButtonElement;
     appearances: typeof buttonAppearances;
+    spacing: typeof buttonSpacing;
 };
 type LinkButtonVariant = {
     name: 'LinkButton';
     Component: typeof LinkButtonRender;
     elementType: typeof HTMLAnchorElement;
     appearances: typeof linkButtonAppearances;
+    spacing: typeof buttonSpacing;
 };
 type IconButtonVariant = {
     name: 'IconButton';
     Component: typeof IconButtonRender;
     elementType: typeof HTMLButtonElement;
     appearances: typeof iconButtonAppearances;
+    spacing: typeof iconButtonSpacing;
 };
 type LinkIconButtonVariant = {
     name: 'LinkIconButton';
     Component: typeof LinkIconButtonRender;
     elementType: typeof HTMLAnchorElement;
     appearances: typeof iconButtonAppearances;
+    spacing: typeof iconButtonSpacing;
 };
 type DefaultButtonVariants = DefaultButtonVariant | LinkButtonVariant;
 type LinkButtonVariants = LinkButtonVariant | LinkIconButtonVariant;

package/dist/types-ts4.5/new-button/variants/default/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { type IconProp, type IconSize } from '../types';
+import { type ButtonSpacing, type IconProp, type IconSize } from '../types';
 export type CommonDefaultButtonProps = {
     /**
      * Text content to be rendered in the button. Required so that screen readers always have an accessible label provided for the button.
@@ -27,4 +27,8 @@ export type CommonDefaultButtonProps = {
      * Option to fit button width to its parent width.
      */
     shouldFitContainer?: boolean;
+    /**
+     * Controls the amount of padding in the button.
+     */
+    spacing?: ButtonSpacing;
 };

package/dist/types-ts4.5/new-button/variants/icon/types.d.ts

@@ -1,4 +1,4 @@
-import { type IconButtonAppearance, type IconProp, type IconSize } from '../types';
+import { type IconButtonAppearance, type IconButtonSpacing, type IconProp, type IconSize } from '../types';
 export type CommonIconButtonProps = {
     /**
      * The button style variation.
@@ -17,6 +17,10 @@ export type CommonIconButtonProps = {
      * Set the shape of the icon, defaults to square with rounded corners.
      */
     shape?: 'default' | 'circle';
+    /**
+     * Controls the amount of padding in the button.
+     */
+    spacing?: IconButtonSpacing;
     /**
      * Set the size of the icon. `medium` is default, so it does not need to be specified.
      * This is UNSAFE as it will be removed in future in favor of a 100% bounded API.

package/dist/types-ts4.5/new-button/variants/shared/use-button-base.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { xcss } from '@atlaskit/primitives';
-import { type Appearance, type CommonButtonProps } from '../types';
+import { type Appearance, type CommonButtonProps, type Spacing } from '../types';
 export type ControlledEvents<TagName extends HTMLElement> = Pick<React.DOMAttributes<TagName>, 'onMouseDownCapture' | 'onMouseUpCapture' | 'onKeyDownCapture' | 'onKeyUpCapture' | 'onTouchStartCapture' | 'onTouchEndCapture' | 'onPointerDownCapture' | 'onPointerUpCapture' | 'onClickCapture'> & Pick<CommonButtonProps<TagName>, 'onClick'>;
 export type UseButtonBaseArgs<TagName extends HTMLElement> = {
     ref: React.Ref<TagName>;
@@ -15,7 +15,8 @@ export type UseButtonBaseArgs<TagName extends HTMLElement> = {
     shouldFitContainer?: boolean;
     appearance?: Appearance;
     children: React.ReactNode;
-} & Pick<CommonButtonProps<TagName>, 'analyticsContext' | 'autoFocus' | 'interactionName' | 'isDisabled' | 'isSelected' | 'overlay' | 'spacing'> & ControlledEvents<TagName>;
+    spacing?: Spacing;
+} & Pick<CommonButtonProps<TagName>, 'analyticsContext' | 'autoFocus' | 'interactionName' | 'isDisabled' | 'isSelected' | 'overlay'> & ControlledEvents<TagName>;
 export type UseButtonBaseReturn<TagName extends HTMLElement> = {
     xcss: ReturnType<typeof xcss>;
     ref(node: TagName | null): void;

package/dist/types-ts4.5/new-button/variants/types.d.ts

@@ -5,7 +5,9 @@ export type ButtonAppearance = 'default' | 'danger' | 'primary' | 'subtle' | 'wa
 export type LinkButtonAppearance = 'default' | 'danger' | 'link' | 'primary' | 'subtle' | 'subtle-link' | 'warning';
 export type IconButtonAppearance = 'default' | 'primary' | 'subtle';
 export type Appearance = ButtonAppearance | LinkButtonAppearance | IconButtonAppearance;
-export type Spacing = 'compact' | 'default' | 'none';
+export type ButtonSpacing = 'compact' | 'default' | 'none';
+export type IconButtonSpacing = 'compact' | 'default';
+export type Spacing = ButtonSpacing | IconButtonSpacing;
 export type IconProp = React.ComponentType<IconProps>;
 export type IconSize = 'small' | 'large' | 'xlarge';
 type Combine<First, Second> = Omit<First, keyof Second> & Second;
@@ -38,10 +40,6 @@ export type CommonButtonProps<TagName extends HTMLElement> = {
      * Handler to be called on focus.
      */
     onFocus?: React.FocusEventHandler<TagName>;
-    /**
-     * Controls the amount of padding in the button.
-     */
-    spacing?: Spacing;
     /**
      * A unique string that appears as data attribute `data-testid` in the rendered code, serving as a hook for automated tests.
      */

package/dist/types-ts4.5/utils/spacing.d.ts

@@ -1,3 +1,4 @@
 import { type Spacing } from '../new-button/variants/types';
-declare const spacing: Spacing[];
-export default spacing;
+declare const buttonSpacing: Spacing[];
+declare const iconButtonSpacing: Spacing[];
+export { buttonSpacing, iconButtonSpacing };

package/dist/types-ts4.5/utils/variants.d.ts

@@ -4,29 +4,34 @@ import { LinkButtonProps } from '../new-button/variants/default/link';
 import { type IconButtonProps } from '../new-button/variants/icon/button';
 import { type LinkIconButtonProps } from '../new-button/variants/icon/link';
 import { buttonAppearances, iconButtonAppearances, linkButtonAppearances } from './appearances';
+import { buttonSpacing, iconButtonSpacing } from './spacing';
 type DefaultButtonVariant = {
     name: 'Button';
     Component: typeof Button;
     elementType: typeof HTMLButtonElement;
     appearances: typeof buttonAppearances;
+    spacing: typeof buttonSpacing;
 };
 type LinkButtonVariant = {
     name: 'LinkButton';
     Component: typeof LinkButtonRender;
     elementType: typeof HTMLAnchorElement;
     appearances: typeof linkButtonAppearances;
+    spacing: typeof buttonSpacing;
 };
 type IconButtonVariant = {
     name: 'IconButton';
     Component: typeof IconButtonRender;
     elementType: typeof HTMLButtonElement;
     appearances: typeof iconButtonAppearances;
+    spacing: typeof iconButtonSpacing;
 };
 type LinkIconButtonVariant = {
     name: 'LinkIconButton';
     Component: typeof LinkIconButtonRender;
     elementType: typeof HTMLAnchorElement;
     appearances: typeof iconButtonAppearances;
+    spacing: typeof iconButtonSpacing;
 };
 type DefaultButtonVariants = DefaultButtonVariant | LinkButtonVariant;
 type LinkButtonVariants = LinkButtonVariant | LinkIconButtonVariant;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/button",
-  "version": "17.6.1",
+  "version": "17.7.0",
   "description": "A button triggers an event or action. They let users know what will happen next.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -144,4 +144,4 @@
   },
   "homepage": "https://atlassian.design/components/button/",
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
-}
+}