@commercetools-uikit/primary-button 19.9.0 → 19.10.0

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

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

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

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

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

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

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

@@ -1,18 +1,65 @@
 import { MouseEvent, KeyboardEvent, ElementType, ReactElement, ComponentPropsWithRef } from 'react';
+/**
+ * @deprecated Use sizes from `TSizes` instead.
+ */
 type TLegacySizes = 'small' | 'medium' | 'big';
+/**
+ * Available sizes for the PrimaryButton.
+ */
 type TSizes = '10' | '20';
 export type TPrimaryButtonProps<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 `<PrimaryButton>` 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;
+    /**
+     * The left icon displayed within the button.
+     */
     iconLeft?: 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.
+     * <br />
+     * Required when `as` is `undefined`
+     */
     onClick?: (event: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>) => void;
+    /**
+     * Sets the size of the button.
+     * <br />
+     * `small`, `medium`, and `big` are deprecated. Use `10`, `20`, instead.
+     */
     size?: TLegacySizes | TSizes;
+    /**
+     * Indicates the color scheme of the button.
+     */
     tone?: 'urgent' | 'primary' | 'critical';
-} & 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 `<PrimaryButton>`: <PrimaryButton as={Link} to="/foo" label="Foo" />.
+ */ ComponentPropsWithRef<TStringOrComponent>;
 declare const PrimaryButton: {
     <TStringOrComponent extends ElementType = "button">(props: TPrimaryButtonProps<TStringOrComponent>): import("@emotion/react/jsx-runtime").JSX.Element;
     defaultProps: Pick<TPrimaryButtonProps<"button">, "size" | "type" | "tone" | "isToggleButton">;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/primary-button",
   "description": "Primary buttons are used for a primary action on a page. You must also pass a label for accessibility reasons.",
-  "version": "19.9.0",
+  "version": "19.10.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-inline": "19.9.0",
-    "@commercetools-uikit/text": "19.9.0",
-    "@commercetools-uikit/utils": "19.9.0",
+    "@commercetools-uikit/accessible-button": "19.10.0",
+    "@commercetools-uikit/design-system": "19.10.0",
+    "@commercetools-uikit/spacings-inline": "19.10.0",
+    "@commercetools-uikit/text": "19.10.0",
+    "@commercetools-uikit/utils": "19.10.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "lodash": "4.17.21",