@commercetools-uikit/icon-button 19.9.0 → 19.11.0

package/dist/commercetools-uikit-icon-button.cjs.dev.js

@@ -193,7 +193,7 @@ IconButton.displayName = 'IconButton';
 var IconButton$1 = IconButton;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 exports["default"] = IconButton$1;
 exports.version = version;

package/dist/commercetools-uikit-icon-button.cjs.prod.js

@@ -172,7 +172,7 @@ IconButton.displayName = 'IconButton';
 var IconButton$1 = IconButton;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 exports["default"] = IconButton$1;
 exports.version = version;

package/dist/commercetools-uikit-icon-button.esm.js

@@ -174,6 +174,6 @@ IconButton.displayName = 'IconButton';
 var IconButton$1 = IconButton;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 export { IconButton$1 as default, version };

package/dist/declarations/src/icon-button.d.ts

@@ -1,22 +1,68 @@
 import { MouseEvent, KeyboardEvent, ElementType, ReactElement, ComponentPropsWithRef } from 'react';
+/**
+ * @deprecated Use sizes from `TSizes` instead.
+ */
 type TLegacySizes = 'small' | 'medium' | 'big';
+/**
+ * Available sizes for the IconButton.
+ */
 type TSizes = '10' | '20' | '30' | '40';
 export type TIconButtonProps<TStringOrComponent extends ElementType = 'button'> = {
+    /**
+     * You may pass in a string like "a" to have the button element render an anchor tag, or
+     * you could pass in a React Component, like a `Link`.
+     * <br />
+     * The `<IconButton>` additionally accepts any props or attributes specific to the given element or component.
+     */
     as?: TStringOrComponent;
+    /**
+     * Used as the HTML type attribute.
+     */
     type?: 'button' | 'reset' | 'submit';
+    /**
+     * Should describe what the button does, for accessibility purposes (screen-reader users)
+     */
     label: string;
+    /**
+     * an <Icon /> component
+     */
     icon?: ReactElement;
+    /**
+     * If this is active, it means the button will persist in an "active" state when toggled (see `isToggled`), and back to normal state when untoggled.
+     */
     isToggleButton?: boolean;
+    /**
+     * Tells when the button should present a toggled state. It does not have any effect when `isToggleButton` is `false`.
+     */
     isToggled?: boolean;
+    /**
+     * Tells when the button should present a disabled state.
+     */
     isDisabled?: boolean;
+    /**
+     * Handler when the button is clicked
+     */
     onClick?: (event: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>) => void;
+    /**
+     * @deprecated This prop is only used in the old theme. For the new theme this prop will not be taken into account and `square` is used by default
+     */
     shape?: 'round' | 'square';
+    /**
+     * The component may have a theme only if `isToggleButton` is `true`
+     */
     theme?: 'default' | 'primary' | 'info';
+    /**
+     * Indicates the size of the icon. Available sizes are '10', '20', '30', '40'.
+     */
     size?: TLegacySizes | TSizes;
-} & ComponentPropsWithRef<TStringOrComponent>;
+} & /**
+ * Include any props derived from the React component passed to the `as` prop.
+ * For example, given `as={Link}`, all props of the `<Link>` component are allowed to be
+ * passed to `<IconButton>`: <IconButton as={Link} to="/foo" label="Foo" />.
+ */ ComponentPropsWithRef<TStringOrComponent>;
 declare const IconButton: {
     <TStringOrComponent extends ElementType = "button">(props: TIconButtonProps<TStringOrComponent>): import("@emotion/react/jsx-runtime").JSX.Element;
-    defaultProps: Pick<TIconButtonProps<"button">, "size" | "type" | "theme" | "shape" | "isToggleButton">;
+    defaultProps: Pick<TIconButtonProps<"button">, "type" | "theme" | "size" | "shape" | "isToggleButton">;
     displayName: string;
 };
 export default IconButton;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/icon-button",
   "description": "Icon buttons are icon-only buttons. They trigger an action when clicked (`onClick` prop). You must also pass a label for accessibility reasons.",
-  "version": "19.9.0",
+  "version": "19.11.0",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,11 +21,11 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/runtime-corejs3": "^7.20.13",
-    "@commercetools-uikit/accessible-button": "19.9.0",
-    "@commercetools-uikit/design-system": "19.9.0",
-    "@commercetools-uikit/spacings": "19.9.0",
-    "@commercetools-uikit/text": "19.9.0",
-    "@commercetools-uikit/utils": "19.9.0",
+    "@commercetools-uikit/accessible-button": "19.11.0",
+    "@commercetools-uikit/design-system": "19.11.0",
+    "@commercetools-uikit/spacings": "19.11.0",
+    "@commercetools-uikit/text": "19.11.0",
+    "@commercetools-uikit/utils": "19.11.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "lodash": "4.17.21",