carbon-react 116.1.3 → 116.2.1

package/lib/components/toast/toast.component.js

@@ -67,7 +67,11 @@ const Toast = /*#__PURE__*/_react.default.forwardRef(({
       onDismiss(ev);
     }
   }, [onDismiss]);
-  (0, _useModalManager.default)(open, dismissToast, refToPass);
+  (0, _useModalManager.default)({
+    open,
+    closeModal: dismissToast,
+    modalRef: refToPass
+  });
   (0, _react.useEffect)(() => {
     /* istanbul ignore next */
     if (timer.current) clearTimeout(timer.current);

package/lib/hooks/__internal__/useMenuKeyboardNavigation/useMenuKeyboardNavigation.js

@@ -31,7 +31,11 @@ var _default = (mainControlRef, childrenRefs, hide, isOpen) => {
   }, [refocusMainControl]); // useModalmanager is used here to handle the escape key
   // and to ensure that closing the menu does not close the modal
 
-  (0, _useModalManager.default)(isOpen, handleEscapeKey, mainControlRef);
+  (0, _useModalManager.default)({
+    open: isOpen,
+    closeModal: handleEscapeKey,
+    modalRef: mainControlRef
+  });
   const handleKeyDown = (0, _react.useCallback)(ev => {
     if (!(_events.default.isEnterKey(ev) || _events.default.isSpaceKey(ev))) {
       ev.preventDefault();

package/lib/hooks/__internal__/useModalManager/useModalManager.d.ts

@@ -1,3 +1,10 @@
 import React from "react";
-declare const useModalManager: (open: boolean, closeModal: (e: KeyboardEvent) => void, modalRef: React.RefObject<HTMLElement>, setTriggerRefocusFlag?: ((flag: boolean) => void) | undefined) => void;
+declare type UseModalManagerArgs = {
+    open: boolean;
+    closeModal: (e: KeyboardEvent) => void;
+    modalRef: React.RefObject<HTMLElement>;
+    setTriggerRefocusFlag?: (flag: boolean) => void;
+    triggerRefocusOnClose?: boolean;
+};
+declare const useModalManager: ({ open, closeModal, modalRef, setTriggerRefocusFlag, triggerRefocusOnClose, }: UseModalManagerArgs) => void;
 export default useModalManager;

package/lib/hooks/__internal__/useModalManager/useModalManager.js

@@ -11,7 +11,13 @@ var _modalManager = _interopRequireDefault(require("../../../components/modal/__
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const useModalManager = (open, closeModal, modalRef, setTriggerRefocusFlag) => {
+const useModalManager = ({
+  open,
+  closeModal,
+  modalRef,
+  setTriggerRefocusFlag,
+  triggerRefocusOnClose = true
+}) => {
   const listenerAdded = (0, _react.useRef)(false);
   const modalRegistered = (0, _react.useRef)(false);
   const handleClose = (0, _react.useCallback)(ev => {
@@ -56,11 +62,11 @@ const useModalManager = (open, closeModal, modalRef, setTriggerRefocusFlag) => {
   }, [setTriggerRefocusFlag]);
   const unregisterModal = (0, _react.useCallback)(ref => {
     if (modalRegistered.current) {
-      _modalManager.default.removeModal(ref);
+      _modalManager.default.removeModal(ref, triggerRefocusOnClose);
 
       modalRegistered.current = false;
     }
-  }, []);
+  }, [triggerRefocusOnClose]);
   (0, _react.useEffect)(() => {
     const ref = modalRef.current;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carbon-react",
-  "version": "116.1.3",
+  "version": "116.2.1",
   "description": "A library of reusable React components for easily building user interfaces.",
   "files": [
     "lib",
@@ -20,7 +20,7 @@
     "copy-files": "node ./scripts/copy-files.js",
     "precompile": "npm run type-check && npm run clean-lib && npm run build && npm run build:types && npm run copy-files",
     "prepublishOnly": "npm run precompile",
-    "postinstall": "node ./scripts/check_rfcs/check_rfcs.js",
+    "postinstall": "node ./scripts/check_rfcs/index.js",
     "watch": "npm run clean-lib && npm run copy-files -- --watch & npm run babel -- --watch",
     "build-storybook": "cross-env STORYBOOK_BUILD=true NODE_OPTIONS=--openssl-legacy-provider build-storybook -c .storybook",
     "start-storybook": "cross-env STORYBOOK_BUILD=true NODE_OPTIONS=--openssl-legacy-provider start-storybook -c .storybook",

package/scripts/check_rfcs/check_rfcs.js

@@ -1,5 +1,4 @@
 /* eslint-disable no-console */
-/* istanbul ignore file */
 const { Octokit } = require("@octokit/rest");
 const dotenv = require("dotenv");
 const chalk = require("chalk");
@@ -32,26 +31,42 @@ const getOpenRfcs = async () => {
   });
 };
 
-const getRfcTitle = (rfc) => rfc.title.split(": ")[1];
+const getTitle = (rfc) => rfc.title.split(": ")[1];
 
 const checkRfcs = async () => {
   if (ci.isCI && process.env.NODE_ENV !== "test") {
     return;
   }
 
-  const openRfcs = await getOpenRfcs();
+  try {
+    const openRfcs = await getOpenRfcs();
 
-  if (openRfcs.length > 0) {
-    console.log("\ncarbon-react currently has open RFCs:");
+    if (!openRfcs.length) return;
 
-    openRfcs.forEach((item) => {
-      const title = getRfcTitle(item);
-      console.log(`- ${title}: ${chalk.cyan(item.html_url)}`);
-    });
-    console.log("\n");
+    const header = chalk.bold.inverse.white(
+      " ".repeat(20),
+      "Open RFCs for carbon-react",
+      " ".repeat(20)
+    );
+
+    const rfcText = openRfcs
+      .map((item) => {
+        const title = getTitle(item);
+        return `- ${chalk.bold(title)}: ${chalk.cyan.italic(item.html_url)}`;
+      })
+      .join("\n\n");
+
+    console.log(`${header}\n\n${rfcText}\n`);
+  } catch (error) {
+    const rfcLink =
+      "https://github.com/Sage/carbon/pulls?q=is%3Aopen+is%3Apr+label%3ARFC";
+    const message = `Failed to retrieve open RFCs for carbon-react. Go to ${chalk.cyan.italic(
+      rfcLink
+    )} to view current RFCs.`;
+    console.log(
+      `${chalk.yellow.inverse(" WARN ")}\n${chalk.yellow(message)}\n`
+    );
   }
 };
 
-checkRfcs();
-
 module.exports = checkRfcs;

package/esm/components/progress-tracker/progress-tracker.d.ts

@@ -1,40 +0,0 @@
-import { MarginProps } from "styled-system";
-
-export interface ProgressTrackerProps extends MarginProps {
-  /** Specifies an aria-label to the component */
-  "aria-label"?: string;
-  /** Specifies the aria-describedby for the component */
-  "aria-describedby"?: string;
-  /** The value of progress to be read out to the user. */
-  "aria-valuenow"?: number;
-  /** The minimum value of the progress tracker */
-  "aria-valuemin"?: number;
-  /** The maximum value of the progress tracker */
-  "aria-valueMax"?: number;
-  /** Prop to define the human readable text alternative of aria-valuenow
-   * if aria-valuenow is not a number */
-  "aria-valuetext"?: string;
-  /** Size of the progressBar. */
-  size?: "small" | "medium" | "large";
-  /** Length of the progress bar, any valid css string. */
-  length?: string;
-  /** Current progress (percentage). */
-  progress?: number;
-  /** Flag to control whether the default value labels (as percentages) should be rendered. */
-  showDefaultLabels?: boolean;
-  /** Value to display as current progress. */
-  currentProgressLabel?: string;
-  /** Value to display as the maximum progress limit. */
-  maxProgressLabel?: string;
-  /**
-   * The position the value label are rendered in.
-   * Top/bottom apply to horizontal and left/right to vertical orientation.
-   */
-  labelsPosition?: "top" | "bottom";
-  /** Value of the preposition defined between Value1 and Value2 on the label. */
-  customValuePreposition?: string;
-}
-
-declare function ProgressTracker(props: ProgressTrackerProps): JSX.Element;
-
-export default ProgressTracker;

package/lib/components/progress-tracker/progress-tracker.d.ts

@@ -1,40 +0,0 @@
-import { MarginProps } from "styled-system";
-
-export interface ProgressTrackerProps extends MarginProps {
-  /** Specifies an aria-label to the component */
-  "aria-label"?: string;
-  /** Specifies the aria-describedby for the component */
-  "aria-describedby"?: string;
-  /** The value of progress to be read out to the user. */
-  "aria-valuenow"?: number;
-  /** The minimum value of the progress tracker */
-  "aria-valuemin"?: number;
-  /** The maximum value of the progress tracker */
-  "aria-valueMax"?: number;
-  /** Prop to define the human readable text alternative of aria-valuenow
-   * if aria-valuenow is not a number */
-  "aria-valuetext"?: string;
-  /** Size of the progressBar. */
-  size?: "small" | "medium" | "large";
-  /** Length of the progress bar, any valid css string. */
-  length?: string;
-  /** Current progress (percentage). */
-  progress?: number;
-  /** Flag to control whether the default value labels (as percentages) should be rendered. */
-  showDefaultLabels?: boolean;
-  /** Value to display as current progress. */
-  currentProgressLabel?: string;
-  /** Value to display as the maximum progress limit. */
-  maxProgressLabel?: string;
-  /**
-   * The position the value label are rendered in.
-   * Top/bottom apply to horizontal and left/right to vertical orientation.
-   */
-  labelsPosition?: "top" | "bottom";
-  /** Value of the preposition defined between Value1 and Value2 on the label. */
-  customValuePreposition?: string;
-}
-
-declare function ProgressTracker(props: ProgressTrackerProps): JSX.Element;
-
-export default ProgressTracker;