@atlaskit/button 17.11.1 → 17.12.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/button
 
+## 17.12.1
+
+### Patch Changes
+
+- [#90619](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/90619) [`acbd9680ed68`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/acbd9680ed68) - Replaces internal ref merge with one from our util set
+
+## 17.12.0
+
+### Minor Changes
+
+- [#89657](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/89657) [`aa76565f1f5b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/aa76565f1f5b) - New buttons now accept render props for icon properties. This can be useful when setting props on icons directly.
+
 ## 17.11.0
 
 ### Minor Changes

package/dist/cjs/new-button/variants/shared/use-button-base.js

@@ -8,6 +8,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireWildcard(require("react"));
+var _mergeRefs = _interopRequireDefault(require("@atlaskit/ds-lib/merge-refs"));
 var _useAutoFocus = _interopRequireDefault(require("@atlaskit/ds-lib/use-auto-focus"));
 var _primitives = require("@atlaskit/primitives");
 var _splitButtonContext = require("../../containers/split-button/split-button-context");
@@ -78,7 +79,7 @@ var useButtonBase = function useButtonBase(_ref) {
     shouldFitContainer = _ref$shouldFitContain === void 0 ? false : _ref$shouldFitContain,
     _ref$spacing = _ref.spacing,
     propSpacing = _ref$spacing === void 0 ? 'default' : _ref$spacing;
-  var ourRef = (0, _react.useRef)();
+  var localRef = (0, _react.useRef)(null);
   var splitButtonContext = (0, _splitButtonContext.useSplitButtonContext)();
   var isSplitButton = Boolean(splitButtonContext);
   var isNavigationSplitButton = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isNavigationSplitButton) || false;
@@ -87,20 +88,7 @@ var useButtonBase = function useButtonBase(_ref) {
   var isDisabled = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isDisabled) || propIsDisabled;
   var isHighlighted = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isHighlighted) || false;
   var isActiveOverSelected = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isActiveOverSelected) || false;
-  var setRef = (0, _react.useCallback)(function (node) {
-    ourRef.current = node;
-    if (ref === null) {
-      return;
-    }
-    if (typeof ref === 'function') {
-      ref(node);
-      return;
-    }
-
-    // @ts-ignore
-    ref.current = node;
-  }, [ourRef, ref]);
-  (0, _useAutoFocus.default)(ourRef, autoFocus);
+  (0, _useAutoFocus.default)(localRef, autoFocus);
   var buttonXCSS = (0, _react.useMemo)(function () {
     return (0, _xcss.getXCSS)({
       appearance: appearance,
@@ -123,7 +111,7 @@ var useButtonBase = function useButtonBase(_ref) {
   }, [appearance, buttonType, spacing, isDisabled, isLoading, isSelected, isHighlighted, isActiveOverSelected, isIconButton, isCircle, shouldFitContainer, overlay, hasIconBefore, hasIconAfter, isSplitButton, isNavigationSplitButton]);
   var isEffectivelyDisabled = isDisabled || Boolean(overlay);
   return _objectSpread({
-    ref: setRef,
+    ref: (0, _mergeRefs.default)([localRef, ref]),
     xcss: buttonXCSS,
     // Consider overlay buttons to be effectively disabled
     isDisabled: isEffectivelyDisabled,

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: "17.11.1",
+    packageVersion: "17.12.1",
     analyticsData: analyticsContext
   });
 

package/dist/es2019/new-button/variants/shared/use-button-base.js

@@ -1,4 +1,5 @@
-import React, { Fragment, useCallback, useMemo, useRef } from 'react';
+import React, { Fragment, useMemo, useRef } from 'react';
+import mergeRefs from '@atlaskit/ds-lib/merge-refs';
 import useAutoFocus from '@atlaskit/ds-lib/use-auto-focus';
 import { Box, xcss } from '@atlaskit/primitives';
 import { useSplitButtonContext } from '../../containers/split-button/split-button-context';
@@ -57,7 +58,7 @@ const useButtonBase = ({
   shouldFitContainer = false,
   spacing: propSpacing = 'default'
 }) => {
-  const ourRef = useRef();
+  const localRef = useRef(null);
   const splitButtonContext = useSplitButtonContext();
   const isSplitButton = Boolean(splitButtonContext);
   const isNavigationSplitButton = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isNavigationSplitButton) || false;
@@ -66,20 +67,7 @@ const useButtonBase = ({
   const isDisabled = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isDisabled) || propIsDisabled;
   const isHighlighted = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isHighlighted) || false;
   const isActiveOverSelected = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isActiveOverSelected) || false;
-  const setRef = useCallback(node => {
-    ourRef.current = node;
-    if (ref === null) {
-      return;
-    }
-    if (typeof ref === 'function') {
-      ref(node);
-      return;
-    }
-
-    // @ts-ignore
-    ref.current = node;
-  }, [ourRef, ref]);
-  useAutoFocus(ourRef, autoFocus);
+  useAutoFocus(localRef, autoFocus);
   const buttonXCSS = useMemo(() => getXCSS({
     appearance,
     spacing,
@@ -100,7 +88,7 @@ const useButtonBase = ({
   }), [appearance, buttonType, spacing, isDisabled, isLoading, isSelected, isHighlighted, isActiveOverSelected, isIconButton, isCircle, shouldFitContainer, overlay, hasIconBefore, hasIconAfter, isSplitButton, isNavigationSplitButton]);
   const isEffectivelyDisabled = isDisabled || Boolean(overlay);
   return {
-    ref: setRef,
+    ref: mergeRefs([localRef, ref]),
     xcss: buttonXCSS,
     // Consider overlay buttons to be effectively disabled
     isDisabled: isEffectivelyDisabled,

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: "17.11.1",
+    packageVersion: "17.12.1",
     analyticsData: analyticsContext
   });
 

package/dist/esm/new-button/variants/shared/use-button-base.js

@@ -1,7 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-import React, { Fragment, useCallback, useMemo, useRef } from 'react';
+import React, { Fragment, useMemo, useRef } from 'react';
+import mergeRefs from '@atlaskit/ds-lib/merge-refs';
 import useAutoFocus from '@atlaskit/ds-lib/use-auto-focus';
 import { Box, xcss } from '@atlaskit/primitives';
 import { useSplitButtonContext } from '../../containers/split-button/split-button-context';
@@ -68,7 +69,7 @@ var useButtonBase = function useButtonBase(_ref) {
     shouldFitContainer = _ref$shouldFitContain === void 0 ? false : _ref$shouldFitContain,
     _ref$spacing = _ref.spacing,
     propSpacing = _ref$spacing === void 0 ? 'default' : _ref$spacing;
-  var ourRef = useRef();
+  var localRef = useRef(null);
   var splitButtonContext = useSplitButtonContext();
   var isSplitButton = Boolean(splitButtonContext);
   var isNavigationSplitButton = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isNavigationSplitButton) || false;
@@ -77,20 +78,7 @@ var useButtonBase = function useButtonBase(_ref) {
   var isDisabled = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isDisabled) || propIsDisabled;
   var isHighlighted = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isHighlighted) || false;
   var isActiveOverSelected = (splitButtonContext === null || splitButtonContext === void 0 ? void 0 : splitButtonContext.isActiveOverSelected) || false;
-  var setRef = useCallback(function (node) {
-    ourRef.current = node;
-    if (ref === null) {
-      return;
-    }
-    if (typeof ref === 'function') {
-      ref(node);
-      return;
-    }
-
-    // @ts-ignore
-    ref.current = node;
-  }, [ourRef, ref]);
-  useAutoFocus(ourRef, autoFocus);
+  useAutoFocus(localRef, autoFocus);
   var buttonXCSS = useMemo(function () {
     return getXCSS({
       appearance: appearance,
@@ -113,7 +101,7 @@ var useButtonBase = function useButtonBase(_ref) {
   }, [appearance, buttonType, spacing, isDisabled, isLoading, isSelected, isHighlighted, isActiveOverSelected, isIconButton, isCircle, shouldFitContainer, overlay, hasIconBefore, hasIconAfter, isSplitButton, isNavigationSplitButton]);
   var isEffectivelyDisabled = isDisabled || Boolean(overlay);
   return _objectSpread({
-    ref: setRef,
+    ref: mergeRefs([localRef, ref]),
     xcss: buttonXCSS,
     // Consider overlay buttons to be effectively disabled
     isDisabled: isEffectivelyDisabled,

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: "17.11.1",
+    packageVersion: "17.12.1",
     analyticsData: analyticsContext
   });
 

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

@@ -10,6 +10,8 @@ export type CommonDefaultButtonProps = {
      */
     iconAfter?: IconProp;
     /**
+     * @deprecated Prefer `iconAfter` render prop for icon customizations.
+     *
      * Set the size of the icon after. `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
      */
@@ -19,6 +21,8 @@ export type CommonDefaultButtonProps = {
      */
     iconBefore?: IconProp;
     /**
+     * @deprecated Prefer `iconBefore` render prop for icon customizations.
+     *
      * Set the size of the icon before. `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/icon/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { TooltipProps } from '@atlaskit/tooltip';
+import { type TooltipProps } from '@atlaskit/tooltip';
 import { type IconButtonAppearance, type IconButtonSpacing, type IconProp, type IconSize } from '../types';
 export type CommonIconButtonProps = {
     'aria-label'?: never;
@@ -36,6 +36,8 @@ export type CommonIconButtonProps = {
      */
     tooltip?: Partial<Omit<TooltipProps, 'children'>>;
     /**
+     * @deprecated Prefer `icon` render prop for icon customizations.
+     *
      * 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/default/types.d.ts

@@ -10,6 +10,8 @@ export type CommonDefaultButtonProps = {
      */
     iconAfter?: IconProp;
     /**
+     * @deprecated Prefer `iconAfter` render prop for icon customizations.
+     *
      * Set the size of the icon after. `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
      */
@@ -19,6 +21,8 @@ export type CommonDefaultButtonProps = {
      */
     iconBefore?: IconProp;
     /**
+     * @deprecated Prefer `iconBefore` render prop for icon customizations.
+     *
      * Set the size of the icon before. `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/icon/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { TooltipProps } from '@atlaskit/tooltip';
+import { type TooltipProps } from '@atlaskit/tooltip';
 import { type IconButtonAppearance, type IconButtonSpacing, type IconProp, type IconSize } from '../types';
 export type CommonIconButtonProps = {
     'aria-label'?: never;
@@ -36,6 +36,8 @@ export type CommonIconButtonProps = {
      */
     tooltip?: Partial<Omit<TooltipProps, 'children'>>;
     /**
+     * @deprecated Prefer `icon` render prop for icon customizations.
+     *
      * 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/button",
-  "version": "17.11.1",
+  "version": "17.12.1",
   "description": "A button triggers an event or action. They let users know what will happen next.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -91,7 +91,7 @@
     "@atlaskit/spinner": "^16.0.0",
     "@atlaskit/theme": "^12.7.0",
     "@atlaskit/tokens": "^1.43.0",
-    "@atlaskit/tooltip": "^18.1.3",
+    "@atlaskit/tooltip": "^18.2.0",
     "@atlaskit/visually-hidden": "^1.2.4",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
@@ -104,6 +104,7 @@
     "@af/integration-testing": "*",
     "@af/visual-regression": "*",
     "@atlaskit/app-provider": "^1.3.0",
+    "@atlaskit/checkbox": "*",
     "@atlaskit/ssr": "*",
     "@atlaskit/visual-regression": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",