@commercetools-uikit/tooltip 19.9.0 → 19.10.0

package/dist/commercetools-uikit-tooltip.cjs.dev.js

@@ -319,7 +319,7 @@ Tooltip.defaultProps = tooltipDefaultProps;
 var Tooltip$1 = Tooltip;
 
 // 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"] = Tooltip$1;
 exports.version = version;

package/dist/commercetools-uikit-tooltip.cjs.prod.js

@@ -281,7 +281,7 @@ Tooltip.defaultProps = tooltipDefaultProps;
 var Tooltip$1 = Tooltip;
 
 // 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"] = Tooltip$1;
 exports.version = version;

package/dist/commercetools-uikit-tooltip.esm.js

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

package/dist/declarations/src/tooltip.d.ts

@@ -1,24 +1,69 @@
 import { Modifiers } from 'popper.js';
 import { ComponentType, FocusEvent, ChangeEvent, CSSProperties, ReactElement } from 'react';
 export type TComponents = {
+    /**
+     * The component rendered as the tooltip body.
+     */
     BodyComponent?: ComponentType;
+    /**
+     * Where the tooltip should be rendered. This can be useful to render the tooltip into another part of the document, using React portal.
+     */
     TooltipWrapperComponent?: ComponentType;
+    /**
+     * A custom component wrapper for the tooltip.
+     */
     WrapperComponent?: ComponentType;
 };
 export type TTooltipProps = {
     children: ReactElement;
+    /**
+     * Delay (in milliseconds) between the start of the user interaction, and showing the tooltip.
+     */
     showAfter?: number;
+    /**
+     * Delay (in milliseconds) between the end of the user interaction, and the closing of the tooltip.
+     */
     closeAfter?: number;
+    /**
+     * Custom css-in-js object styles for the tooltip body.
+     */
     styles?: Record<string, CSSProperties>;
+    /**
+     * Determines if the tooltip should not appear.
+     */
     off: boolean;
+    /**
+     * An identifier for the tooltip, used for `aria-describedby`.
+     */
     id?: string;
+    /**
+     * A callback function, called when the tooltip is closing.
+     */
     onClose?: (e?: ChangeEvent | FocusEvent) => void;
+    /**
+     * A callback function, called when the tooltip is opening.
+     */
     onOpen?: (e?: ChangeEvent | FocusEvent) => void;
     isOpen?: boolean;
+    /**
+     * How the tooltip is positioned relative to the child element.
+     */
     placement?: 'top' | 'top-start' | 'top-end' | 'right' | 'right-start' | 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end';
+    /**
+     * The message to show in the tooltip.
+     */
     title: string;
+    /**
+     * Provides a way to fine-tune an appearance of underlying Popper tooltip element. For more information, please check [Popper.js documentation](https://popper.js.org/popper-documentation.html#modifiers).
+     */
     modifiers?: Modifiers;
+    /**
+     * Customize the appearance of certain elements of the tooltip.
+     */
     components?: TComponents;
+    /**
+     * Horizontal size limit of the tooltip.
+     */
     horizontalConstraint?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
 };
 export type TTooltipState = 'closed' | 'entering' | 'opened' | 'exiting';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/tooltip",
   "description": "Tooltips display informative text when users hover over or focus on an element.",
-  "version": "19.9.0",
+  "version": "19.10.0",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,10 +21,10 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/runtime-corejs3": "^7.20.13",
-    "@commercetools-uikit/constraints": "19.9.0",
-    "@commercetools-uikit/design-system": "19.9.0",
-    "@commercetools-uikit/hooks": "19.9.0",
-    "@commercetools-uikit/utils": "19.9.0",
+    "@commercetools-uikit/constraints": "19.10.0",
+    "@commercetools-uikit/design-system": "19.10.0",
+    "@commercetools-uikit/hooks": "19.10.0",
+    "@commercetools-uikit/utils": "19.10.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "lodash": "4.17.21",