@commercetools-uikit/collapsible-panel 19.9.0 → 19.10.0

package/dist/commercetools-uikit-collapsible-panel.cjs.dev.js

@@ -311,7 +311,7 @@ CollapsiblePanel.Header = CollapsiblePanelHeader$1;
 var CollapsiblePanel$1 = CollapsiblePanel;
 
 // 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"] = CollapsiblePanel$1;
 exports.version = version;

package/dist/commercetools-uikit-collapsible-panel.cjs.prod.js

@@ -248,7 +248,7 @@ CollapsiblePanel.Header = CollapsiblePanelHeader$1;
 var CollapsiblePanel$1 = CollapsiblePanel;
 
 // 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"] = CollapsiblePanel$1;
 exports.version = version;

package/dist/commercetools-uikit-collapsible-panel.esm.js

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

package/dist/declarations/src/collapsible-panel.d.ts

@@ -1,26 +1,94 @@
 import { ReactNode } from 'react';
 export type TCollapsiblePanel = {
+    /**
+     * An unique id for the panel header, which will also be used to generate a prefixed id for the panel content section.
+     * <br/>
+     * Read about `getPanelContentId` below for more about this.
+     */
     id?: string;
+    /**
+     * The title being rendered at top left of the panel
+     */
     header: ReactNode;
+    /**
+     * A secondary header for the panel (only pass if needed)
+     */
     secondaryHeader?: ReactNode;
+    /**
+     * If passed will be shown below the title as more information regarding the panel
+     */
     description?: string;
+    /**
+     * Allow to override the styles by passing a `className` prop.
+     * <br/>
+     * Custom styles can also be passed using the [`css` prop from emotion](https://emotion.sh/docs/css-prop#style-precedence).
+     */
     className?: string;
+    /**
+     * Makes the panel's header sticky in regards to the page's scroll
+     */
     isSticky?: boolean;
+    /**
+     * Controls at the top right part of the panel
+     */
     headerControls?: ReactNode;
+    /**
+     * Disables the panel and all interactions with it
+     */
     isDisabled?: boolean;
+    /**
+     * The actual content rendered inside the panel
+     */
     children?: ReactNode;
+    /**
+     * Indicates the color scheme of the panel.
+     */
     tone?: 'urgent' | 'primary';
+    /**
+     * Determines the background color of the panel.
+     */
     theme?: 'dark' | 'light';
+    /**
+     * Whenever `true` the headers and content itself
+     * will consume less space in that to the borders are smaller and everything has less padding
+     */
     condensed?: boolean;
+    /**
+     * Controls the visibility of the expansion controls on the left
+     */
     hideExpansionControls?: boolean;
+    /**
+     * Indicates the position of the control elements in the header component.
+     */
     headerControlsAlignment?: 'left' | 'right';
+    /**
+     * Indicates if the panel's content should be collapsed or shown by default.
+     * <br />
+     * Updates to this value are not respected. Only used for **uncontrolled** mode (when no`onToggle` is passed.)
+     */
     isDefaultClosed?: boolean;
+    /**
+     * Indicates if the panel's content should be collapsed or shown.
+     * <br />
+     * Component becomes **controlled* when this is passed.
+     */
     isClosed?: boolean;
+    /**
+     * function to be triggered whenever the user clicks the top area to collapse the panel's content
+     * <br />
+     * Becomes required when `isClosed` is passed.
+     */
     onToggle?: () => void;
+    /**
+     * Horizontal size limit of the panel.
+     */
     horizontalConstraint?: 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
 };
 declare const CollapsiblePanel: {
     (props: TCollapsiblePanel): import("@emotion/react/jsx-runtime").JSX.Element;
+    /**
+     * @deprecated This function is no longer supported.
+     */
     getPanelContentId(): string;
     displayName: string;
     defaultProps: Pick<TCollapsiblePanel, "condensed" | "theme" | "isDisabled" | "horizontalConstraint" | "headerControlsAlignment">;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/collapsible-panel",
   "description": "A panel to collapse and expand your content.",
-  "version": "19.9.0",
+  "version": "19.10.0",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/runtime-corejs3": "^7.20.13",
-    "@commercetools-uikit/accessible-button": "19.9.0",
-    "@commercetools-uikit/collapsible-motion": "19.9.0",
-    "@commercetools-uikit/constraints": "19.9.0",
-    "@commercetools-uikit/design-system": "19.9.0",
-    "@commercetools-uikit/hooks": "19.9.0",
-    "@commercetools-uikit/icons": "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.10.0",
+    "@commercetools-uikit/collapsible-motion": "19.10.0",
+    "@commercetools-uikit/constraints": "19.10.0",
+    "@commercetools-uikit/design-system": "19.10.0",
+    "@commercetools-uikit/hooks": "19.10.0",
+    "@commercetools-uikit/icons": "19.10.0",
+    "@commercetools-uikit/spacings": "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",