@carbon/ibm-products 2.34.0 → 2.36.0-alpha.27

package/es/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.d.ts

@@ -1,7 +1,45 @@
+/**
+ * Copyright IBM Corp. 2021, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { PropsWithChildren } from 'react';
+interface HTTPErrorOtherProps extends PropsWithChildren {
+    /**
+     * Provide an optional class to be applied to the containing node
+     */
+    className?: string;
+    /**
+     * String that will provide the description for the HTTP error code
+     */
+    description: string;
+    /**
+     * String that will describe the error that occurred
+     */
+    errorCodeLabel: string;
+    /**
+     * Links that will display for extra context when receiving particular errors
+     */
+    links?: Array<{
+        /**
+         * The text to display for the link
+         */
+        text: string;
+        /**
+         * The link's destination
+         */
+        href: string;
+    }>;
+    /**
+     * This will be for the main title of the HTTP error component
+     */
+    title: string;
+}
 /**
  * HTTP errors are used in an attempt to access something that isn’t available or
 the user doesn’t have permission for. This HTTPError component is generic so you
 can use it when you receive an error code that isn't provided.
  */
-export let HTTPErrorOther: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let HTTPErrorOther: React.ForwardRefExoticComponent<HTTPErrorOtherProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js

@@ -19,7 +19,6 @@ var _excluded = ["className", "description", "errorCodeLabel", "links", "title"]
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--http-errors");
 var componentName = 'HTTPErrorOther';
-
 /**
  * HTTP errors are used in an attempt to access something that isn’t available or
 the user doesn’t have permission for. This HTTPError component is generic so you
@@ -71,6 +70,7 @@ HTTPErrorOther.propTypes = {
   /**
    * Links that will display for extra context when receiving particular errors
    */
+  /**@ts-ignore */
   links: propTypesExports.arrayOf(propTypesExports.shape({
     /**
      * The text to display for the link

package/es/components/ImportModal/ImportModal.d.ts

@@ -1,2 +1,136 @@
-export let ImportModal: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+/**
+ * Copyright IBM Corp. 2021, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { ReactNode } from 'react';
+type FileType = {
+    fetchError?: undefined | boolean;
+    fileData?: File;
+    fileSize?: number;
+    iconDescription?: string;
+    invalidFileType?: boolean;
+    name: string;
+    status?: string;
+    uuid?: string;
+    invalid?: boolean;
+    errorBody?: string;
+    errorSubject?: string;
+};
+interface ImportModalProps {
+    /**
+     * Specifies the file types that are valid for importing
+     */
+    accept?: string[];
+    /**
+     * Optional class name
+     */
+    className?: string;
+    /**
+     * The default message shown for an import error
+     */
+    defaultErrorBody: string;
+    /**
+     * The default header that is displayed to show an error message
+     */
+    defaultErrorHeader: string;
+    /**
+     * Content that is displayed inside the modal
+     */
+    description?: string;
+    /**
+     * Optional error body to display specifically for a fetch error
+     */
+    fetchErrorBody?: string;
+    /**
+     * Optional error header to display specifically for a fetch error
+     */
+    fetchErrorHeader?: string;
+    /**
+     * Header for the drag and drop box
+     */
+    fileDropHeader?: string;
+    /**
+     * Label for the drag and drop box
+     */
+    fileDropLabel?: string;
+    /**
+     * Label that appears when a file is uploaded to show number of files (1 / 1)
+     */
+    fileUploadLabel?: string;
+    /**
+     * Button icon for import by url button
+     */
+    inputButtonIcon?: boolean;
+    /**
+     * Button text for import by url button
+     */
+    inputButtonText: string;
+    /**
+     * ID for text input
+     */
+    inputId?: string;
+    /**
+     * Header to display above import by url
+     */
+    inputLabel?: string;
+    /**
+     * Placeholder for text input
+     */
+    inputPlaceholder?: string;
+    /**
+     * Optional error message to display specifically for a invalid file type error
+     */
+    invalidFileTypeErrorBody?: string;
+    /**
+     * Optional error header to display specifically for a invalid file type error
+     */
+    invalidFileTypeErrorHeader?: string;
+    /**
+     * Description for delete file icon
+     */
+    invalidIconDescription?: string;
+    /**
+     * File size limit in bytes
+     */
+    maxFileSize?: number;
+    /**
+     * Optional error message to display specifically for a max file size error
+     */
+    maxFileSizeErrorBody?: string;
+    /**
+     * Optional error header to display specifically for a max file size error
+     */
+    maxFileSizeErrorHeader?: string;
+    /**
+     * Specify a handler for closing modal
+     */
+    onClose?(): void;
+    /**
+     * Specify a handler for "submitting" modal. Access the imported file via `file => {}`
+     */
+    onRequestSubmit(files: FileType[]): void;
+    /**
+     * Specify whether the Modal is currently open
+     */
+    open: boolean;
+    /**
+     * The DOM node the tearsheet should be rendered within. Defaults to document.body.
+     */
+    portalTarget?: ReactNode;
+    /**
+     * Specify the text for the primary button
+     */
+    primaryButtonText: string;
+    /**
+     * Specify the text for the secondary button
+     */
+    secondaryButtonText: string;
+    /**
+     * The text displayed at the top of the modal
+     */
+    title: string;
+}
+export declare let ImportModal: React.FC<ImportModalProps>;
+export {};

package/es/components/ImportModal/ImportModal.js

@@ -76,6 +76,7 @@ var ImportModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
   };
   var updateFiles = function updateFiles(newFiles) {
     var updatedFiles = newFiles.map(function (file) {
+      var _newFile$fileSize;
       var newFile = {
         uuid: file.uuid || uuidv4(),
         status: 'edit',
@@ -94,7 +95,7 @@ var ImportModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
         newFile.errorBody = invalidFileTypeErrorBody || defaultErrorBody;
         newFile.errorSubject = invalidFileTypeErrorHeader || defaultErrorHeader;
         newFile.invalid = true;
-      } else if (maxFileSize && newFile.fileSize > maxFileSize) {
+      } else if (maxFileSize && ((_newFile$fileSize = newFile === null || newFile === void 0 ? void 0 : newFile.fileSize) !== null && _newFile$fileSize !== void 0 ? _newFile$fileSize : 0) > maxFileSize) {
         newFile.errorBody = maxFileSizeErrorBody || defaultErrorBody;
         newFile.errorSubject = maxFileSizeErrorHeader || defaultErrorHeader;
         newFile.invalid = true;
@@ -127,7 +128,7 @@ var ImportModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
               _context.next = 10;
               break;
             }
-            throw new Error(response.status);
+            throw new Error("".concat(response.status));
           case 10:
             _context.next = 12;
             return response.blob();

package/es/components/InlineTip/InlineTip.d.ts

@@ -1,7 +1,95 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { ReactNode } from 'react';
+type MediaType = {
+    render?: () => ReactNode;
+    filePaths?: string[];
+};
+interface InlineTipProps {
+    /**
+     * Optional "call to action" ghost button or link that can appear
+     * directly below the content. This component comes with pre-styled
+     * elements available to use: `InlineTipLink` and `InlineTipButton`.
+     */
+    action?: ReactNode;
+    /**
+     * Provide the contents of the InlineTip.
+     */
+    children: ReactNode;
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * Tooltip text and aria label for the Close button icon.
+     */
+    closeIconDescription?: string;
+    /**
+     * The label for the collapse button.
+     * This button is not visible if `media` is specified.
+     */
+    collapseButtonLabel?: string;
+    /**
+     * If set to `true`, it will truncate the body text to
+     * one line and expose an expand/collapse button toggle.
+     *
+     * This feature is disabled if `media` is specified.
+     */
+    collapsible?: boolean;
+    /**
+     * The label for the expand button.
+     * This button is not visible if `media` is specified.
+     */
+    expandButtonLabel?: string;
+    /**
+     * The object describing an image in one of two shapes.
+     * - If a single media element is required, use `{render}`.
+     * - If a stepped animation is required, use `{filePaths}`.
+     *
+     * Enabling `media` disables the `collapsible` feature.
+     */
+    media: MediaType;
+    /**
+     * Set to `true` to arrange the information in a format
+     * that is easier to read in a limited space.
+     */
+    narrow?: boolean;
+    /**
+     * Function to call when the tertiary button is clicked.
+     */
+    onClick?: () => void;
+    /**
+     * Function to call when the InlineTip is closed via the "X" button.
+     */
+    onClose?: () => void;
+    /**
+     * Defining the label will show a the tertiary button with the crossroads icon.
+     * You will still need to define the `onClose` method to trigger a callback.
+     */
+    tertiaryButtonLabel?: string;
+    /**
+     * The title of the InlineTip.
+     */
+    title: string;
+    /**
+     * If true, insert 1 rem of "space" on the left of the component.
+     * This will allow the component's content to line up with other
+     * content on the page under special circumstances.
+     *
+     * This will only be applied when `narrow` is false.
+     */
+    withLeftGutter?: boolean;
+}
 /**
  * Inline tips are messages embedded within other components that
  * provide an ambient way to deliver learning content without
  * distracting the user from their flow.
  */
-export let InlineTip: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let InlineTip: React.ForwardRefExoticComponent<InlineTipProps & {
+    children?: React.ReactNode;
+} & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/InlineTip/InlineTip.js

@@ -35,9 +35,9 @@ var defaults = {
   narrow: false,
   withLeftGutter: false,
   onClick: function onClick() {},
-  onClose: function onClose() {}
+  onClose: function onClose() {},
+  title: 'Use case-specific heading'
 };
-
 /**
  * Inline tips are messages embedded within other components that
  * provide an ambient way to deliver learning content without
@@ -187,6 +187,7 @@ InlineTip.propTypes = {
    *
    * Enabling `media` disables the `collapsible` feature.
    */
+  /**@ts-ignore*/
   media: PropTypes.oneOfType([PropTypes.shape({
     render: PropTypes.func
   }), PropTypes.shape({

package/es/components/InlineTip/InlineTipLink.d.ts

@@ -1,5 +1,22 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { PropsWithChildren, ReactNode } from 'react';
+interface InlineTipLinkProps extends PropsWithChildren {
+    /**
+     * Provide the contents of the InlineTipLink.
+     */
+    children: ReactNode;
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+}
 /**
  * This is a standard Carbon link, styled specifically for use inside InlineTip.
  */
-export let InlineTipLink: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let InlineTipLink: React.ForwardRefExoticComponent<InlineTipLinkProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/InterstitialScreenView/InterstitialScreenView.d.ts

@@ -1,5 +1,26 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { PropsWithChildren, ReactNode } from 'react';
+interface InterstitialScreenViewProps extends PropsWithChildren {
+    /**
+     * Provide the contents of the InterstitialScreenView.
+     */
+    children?: ReactNode;
+    /**
+     * Optional class name for this component.
+     */
+    className?: string;
+    /**
+     * The label to pass to the ProgressStep component.
+     */
+    stepTitle: string;
+}
 /**
  * A Novice to Pro component intended to be used as the child elements of the InterstitialScreen component.
  */
-export let InterstitialScreenView: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let InterstitialScreenView: React.ForwardRefExoticComponent<InterstitialScreenViewProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/InterstitialScreenView/InterstitialScreenView.js

@@ -20,7 +20,6 @@ var _excluded = ["children", "className", "stepTitle"];
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--interstitial-screen-view");
 var componentName = 'InterstitialScreenView';
-
 /**
  * A Novice to Pro component intended to be used as the child elements of the InterstitialScreen component.
  */

package/es/components/InterstitialScreenViewModule/InterstitialScreenViewModule.d.ts

@@ -1,5 +1,26 @@
 /**
- * View module to help in building interstitial screen views.
+ * Copyright IBM Corp. 2024, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
  */
-export let InterstitialScreenViewModule: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
 import React from 'react';
+interface InterstitialScreenViewModuleProps {
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The description of this component.
+     */
+    description: string;
+    /**
+     * The title of this component.
+     */
+    title: string;
+}
+/**
+ * View module to help in building interstitial screen views.
+ */
+export declare let InterstitialScreenViewModule: React.ForwardRefExoticComponent<InterstitialScreenViewModuleProps & React.RefAttributes<HTMLElement>>;
+export {};

package/es/components/Nav/Nav.js

@@ -102,7 +102,7 @@ var Nav = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
    */
   var handleListClick = function handleListClick(id) {
     Object.keys(navigationLists.current).forEach(function (key) {
-      if (key !== id && !navigationLists.current[key].isExpandedOnPageload) {
+      if (key !== id && !navigationLists.current[key].isExpandedOnPageLoad) {
         navigationLists.current[key].close();
       }
     });

package/es/components/Nav/NavList.js

@@ -22,7 +22,7 @@ var defaults = {
   className: '',
   children: null,
   id: '',
-  isExpandedOnPageload: false,
+  isExpandedOnPageLoad: false,
   onItemClick: function onItemClick() {},
   onListClick: function onListClick() {},
   tabIndex: 0,
@@ -41,8 +41,8 @@ var NavList = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     icon = _ref$icon === void 0 ? defaults.icon : _ref$icon,
     _ref$id = _ref.id,
     id = _ref$id === void 0 ? defaults.id : _ref$id,
-    _ref$isExpandedOnPage = _ref.isExpandedOnPageload,
-    isExpandedOnPageload = _ref$isExpandedOnPage === void 0 ? defaults.isExpandedOnPageload : _ref$isExpandedOnPage,
+    _ref$isExpandedOnPage = _ref.isExpandedOnPageLoad,
+    isExpandedOnPageLoad = _ref$isExpandedOnPage === void 0 ? defaults.isExpandedOnPageLoad : _ref$isExpandedOnPage,
     _ref$navigationItemTi = _ref.navigationItemTitle,
     navigationItemTitle = _ref$navigationItemTi === void 0 ? defaults.navigationItemTitle : _ref$navigationItemTi,
     _ref$onItemClick = _ref.onItemClick,
@@ -53,7 +53,7 @@ var NavList = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     tabIndex = _ref$tabIndex === void 0 ? defaults.tabIndex : _ref$tabIndex,
     _ref$title = _ref.title,
     title = _ref$title === void 0 ? defaults.title : _ref$title;
-  var _useState = useState(isExpandedOnPageload),
+  var _useState = useState(isExpandedOnPageLoad),
     _useState2 = _slicedToArray(_useState, 2),
     open = _useState2[0],
     setOpen = _useState2[1];
@@ -65,7 +65,7 @@ var NavList = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       var childProps = _ref3.props;
       return childProps.href;
     });
-    setOpen(hrefs.includes(activeHref) || isExpandedOnPageload);
+    setOpen(hrefs.includes(activeHref) || isExpandedOnPageLoad);
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
 
@@ -99,7 +99,7 @@ var NavList = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   useImperativeHandle(ref, function () {
     return {
       close: close,
-      isExpandedOnPageload: isExpandedOnPageload
+      isExpandedOnPageLoad: isExpandedOnPageLoad
     };
   });
   var newChildren = React__default.Children.map(children, function (child, index) {
@@ -150,7 +150,7 @@ NavList.propTypes = {
   /** @type {string} ID of a list. */
   id: propTypesExports.string,
   /** @type {boolean} State of a list. */
-  isExpandedOnPageload: propTypesExports.bool,
+  isExpandedOnPageLoad: propTypesExports.bool,
   /** @type {boolean} Title of nav. */
   navigationItemTitle: propTypesExports.string,
   /** @type {Function} Click handler for an item. */

package/es/components/NonLinearReading/NonLinearReading.d.ts

@@ -1,7 +1,33 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { ReactNode } from 'react';
+type Theme = 'light' | 'dark';
+interface NonLinearReadingProps {
+    /**
+     * The keyword of the component appears as a pill.
+     */
+    children: ReactNode;
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The content that appears when the keyword is toggled open.
+     */
+    definition: ReactNode;
+    /**
+     * Determines the theme of the component.
+     */
+    theme?: Theme;
+}
 /**
  * Use non-linear reading when space is limited to share a
  * brief, at-a-glance, summary of a concept that may require
  * more explanation for some users.
  */
-export let NonLinearReading: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let NonLinearReading: React.ForwardRefExoticComponent<NonLinearReadingProps & React.RefAttributes<HTMLSpanElement>>;
+export {};

package/es/components/NonLinearReading/NonLinearReading.js

@@ -20,12 +20,6 @@ var _excluded = ["children", "className", "definition", "theme"];
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--non-linear-reading");
 var componentName = 'NonLinearReading';
-
-// Default values for props
-var defaults = {
-  theme: 'light'
-};
-
 /**
  * Use non-linear reading when space is limited to share a
  * brief, at-a-glance, summary of a concept that may require
@@ -36,7 +30,7 @@ var NonLinearReading = /*#__PURE__*/React__default.forwardRef(function (_ref, re
     className = _ref.className,
     definition = _ref.definition,
     _ref$theme = _ref.theme,
-    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    theme = _ref$theme === void 0 ? 'light' : _ref$theme,
     rest = _objectWithoutProperties(_ref, _excluded);
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
@@ -73,6 +67,7 @@ NonLinearReading.propTypes = {
   /**
    * The keyword of the component appears as a pill.
    */
+
   children: PropTypes.node.isRequired,
   /**
    * Provide an optional class to be applied to the containing node.

package/es/components/NotificationsPanel/NotificationsPanel.js

@@ -317,7 +317,7 @@ var NotificationsPanel = /*#__PURE__*/React__default.forwardRef(function (_ref,
     id: blockClass,
     className: cx(blockClass, className, "".concat(blockClass, "__container")),
     style: {
-      animation: !reducedMotion.matches ? "".concat(open ? 'fade-in 250ms' : 'fade-out 250ms') : null
+      animation: !reducedMotion.matches ? "".concat(open ? 'fade-in 250ms' : 'fade-out forwards 250ms') : null
     },
     onAnimationEnd: onAnimationEnd,
     ref: ref || notificationPanelRef

package/es/components/PageHeader/PageHeader.js

@@ -186,7 +186,7 @@ var PageHeader = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     checkUpdateVerticalSpace();
   };
   var handleCollapseToggle = function handleCollapseToggle() {
-    utilSetCollapsed(!fullyCollapsed, metrics.headerOffset, metrics.headerTopValue);
+    utilSetCollapsed(!fullyCollapsed, headerRef, metrics.headerOffset, metrics.headerTopValue);
   };
 
   // use effects
@@ -305,9 +305,9 @@ var PageHeader = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   };
   useEffect(function () {
     if (collapseHeader === true) {
-      utilSetCollapsed(collapseHeader, metrics.headerOffset, metrics.headerTopValue);
+      utilSetCollapsed(collapseHeader, headerRef, metrics.headerOffset, metrics.headerTopValue);
     }
-  }, [collapseHeader, metrics.headerOffset, metrics.headerTopValue]);
+  }, [collapseHeader, metrics.headerOffset, metrics.headerTopValue, headerRef]);
   useResizeObserver(sizingContainerRef, handleResizeActionBarColumn);
   useResizeObserver(headerRef, handleResize);
 

package/es/components/PageHeader/PageHeaderUtils.d.ts

@@ -1,6 +1,6 @@
 export const blockClass: string;
 export function utilCheckUpdateVerticalSpace(headerRef: {}, offsetTopMeasuringRef: {}, navigation: {}, enableBreadcrumbScroll: boolean, hasActionBar: boolean, widthIsNarrow: boolean, setMetrics: () => any): void;
-export function utilSetCollapsed(collapse: any, headerOffset: any, headerTopValue: any): void;
+export function utilSetCollapsed(collapse: any, headerRef: any, headerOffset: any, headerTopValue: any): void;
 export function utilGetBreadcrumbItemForTitle(blockClass: any, collapseTitle: any, title: any): {
     label: any;
     title: any;

package/es/components/PageHeader/PageHeaderUtils.js

@@ -139,16 +139,17 @@ var utilCheckUpdateVerticalSpace = function utilCheckUpdateVerticalSpace(headerR
 };
 
 // Trigger a window scroll, if necessary, to set the collapsed state.
-var utilSetCollapsed = function utilSetCollapsed(collapse, headerOffset, headerTopValue) {
+var utilSetCollapsed = function utilSetCollapsed(collapse, headerRef, headerOffset, headerTopValue) {
   /* don't know how to test resize */
   /* istanbul ignore else */
+  var scrollableTarget = scrollableAncestor(headerRef.current);
   if (collapse) {
-    window.scrollTo({
+    scrollableTarget.scrollTo({
       top: headerOffset - headerTopValue,
       behavior: 'smooth'
     });
   } else {
-    window.scrollTo({
+    scrollableTarget.scrollTo({
       top: 0,
       behavior: 'smooth'
     });