carbon-react 107.1.8 → 108.0.0

package/esm/locales/locale.d.ts

@@ -33,6 +33,9 @@ interface Locale {
             formSummary: (errors: number, warnings: number, type: string) => [string, string] | null;
         };
     };
+    heading: {
+        backLinkAriaLabel: () => string;
+    };
     message: {
         closeButtonAriaLabel: () => string;
     };

package/esm/locales/pl-pl.js

@@ -55,6 +55,9 @@ const plPL = {
       }
     }
   },
+  heading: {
+    backLinkAriaLabel: () => "Wstecz"
+  },
   message: {
     closeButtonAriaLabel: () => "Zamknij"
   },

package/esm/style/utils/filter-styled-system-padding-props.d.ts

@@ -1,3 +1,3 @@
 import { PaddingProps } from "styled-system";
 export declare const paddingPropertyNames: string[];
-export default function filterStyledSystemPaddingProps(originalObject: Record<string, unknown>): PaddingProps;
+export default function filterStyledSystemPaddingProps(props: Record<string, any>): PaddingProps;

package/esm/style/utils/filter-styled-system-padding-props.js

@@ -1,5 +1,7 @@
 import filterObjectProperties from "../../__internal__/filter-object-properties";
 export const paddingPropertyNames = ["padding", "p", "paddingLeft", "pl", "paddingRight", "pr", "paddingTop", "pt", "paddingBottom", "pb", "paddingX", "px", "paddingY", "py"];
-export default function filterStyledSystemPaddingProps(originalObject) {
-  return filterObjectProperties(originalObject, paddingPropertyNames);
+export default function filterStyledSystemPaddingProps( // method should accept any react prop
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+props) {
+  return filterObjectProperties(props, paddingPropertyNames);
 }

package/lib/components/form/form.component.js

@@ -11,12 +11,14 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 
 var _propTypes2 = _interopRequireDefault(require("@styled-system/prop-types"));
 
+var _modal = require("../modal/modal.component");
+
+var _sidebar = require("../sidebar/sidebar.component");
+
 var _formSummary = _interopRequireDefault(require("./__internal__/form-summary.component"));
 
 var _form = require("./form.style");
 
-var _sidebar = require("../sidebar/sidebar.component");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
@@ -43,6 +45,9 @@ const Form = ({
   const {
     isInSidebar
   } = (0, _react.useContext)(_sidebar.SidebarContext);
+  const {
+    isInModal
+  } = (0, _react.useContext)(_modal.ModalContext);
   const formRef = (0, _react.useRef)();
   const formFooterRef = (0, _react.useRef)();
   const renderFooter = !!(saveButton || leftSideButtons || rightSideButtons || errorCount || warningCount);
@@ -57,8 +62,9 @@ const Form = ({
     height: height
   }, rest), /*#__PURE__*/_react.default.createElement(_form.StyledFormContent, {
     "data-element": "form-content",
+    className: stickyFooter ? "sticky" : "",
     stickyFooter: stickyFooter,
-    className: stickyFooter ? "sticky" : ""
+    isInModal: isInModal
   }, children), renderFooter && /*#__PURE__*/_react.default.createElement(_form.StyledFormFooter, {
     "data-element": "form-footer",
     className: stickyFooter ? "sticky" : "",

package/lib/components/form/form.style.js

@@ -37,10 +37,11 @@ function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj;
 
 const StyledFormContent = _styledComponents.default.div`
   ${({
-  stickyFooter
+  stickyFooter,
+  isInModal
 }) => (0, _styledComponents.css)`
     ${stickyFooter && (0, _styledComponents.css)`
-      overflow-y: auto;
+      overflow-y: ${isInModal ? "visible" : "auto"};
       flex: 1;
     `}
   `}

package/lib/components/heading/heading.component.js

@@ -17,6 +17,8 @@ var _tags = _interopRequireDefault(require("../../__internal__/utils/helpers/tag
 
 var _heading = require("./heading.style");
 
+var _useLocale = _interopRequireDefault(require("../../hooks/__internal__/useLocale"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
@@ -47,6 +49,8 @@ const Heading = ({
     }, help);
   };
 
+  const l = (0, _useLocale.default)();
+
   const getBackButton = () => {
     const backButtonProps = typeof backLink === "string" ? {
       href: backLink
@@ -55,8 +59,9 @@ const Heading = ({
     };
     return /*#__PURE__*/_react.default.createElement(_heading.StyledHeadingBackButton // this event allows an element to be focusable on click event on IE
     , _extends({
-      onMouseDown: e => e.currentTarget.focus(),
-      "data-element": "back"
+      "aria-label": l.heading.backLinkAriaLabel(),
+      "data-element": "back",
+      onMouseDown: e => e.currentTarget.focus()
     }, backButtonProps), /*#__PURE__*/_react.default.createElement(_heading.StyledHeadingIcon, {
       type: "chevron_left",
       divider: divider

package/lib/components/help/help.component.js

@@ -83,6 +83,7 @@ const Help = ({
 
   return /*#__PURE__*/_react.default.createElement(_help.default, _extends({
     "aria-describedby": isFocused || isTooltipVisible ? tooltipId || defaultTooltipId.current : undefined,
+    "aria-label": helpAriaLabel || ariaLabel,
     className: className,
     as: tagType,
     href: href,
@@ -101,8 +102,7 @@ const Help = ({
     target: "_blank",
     rel: "noopener noreferrer"
   } : {
-    role: "button",
-    "aria-label": helpAriaLabel || ariaLabel
+    role: "button"
   }, (0, _utils.filterStyledSystemMarginProps)(rest), rest), /*#__PURE__*/_react.default.createElement(_icon.default, {
     "aria-hidden": true,
     type: type,

package/lib/components/modal/index.d.ts

@@ -1 +1 @@
-export { default } from "./modal";
+export { default, ModalContext } from "./modal.component";

package/lib/components/modal/index.js

@@ -9,7 +9,15 @@ Object.defineProperty(exports, "default", {
     return _modal.default;
   }
 });
+Object.defineProperty(exports, "ModalContext", {
+  enumerable: true,
+  get: function () {
+    return _modal.ModalContext;
+  }
+});
+
+var _modal = _interopRequireWildcard(require("./modal.component"));
 
-var _modal = _interopRequireDefault(require("./modal.component"));
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/lib/components/modal/modal.component.d.ts

@@ -0,0 +1,35 @@
+export const ModalContext: React.Context<{}>;
+export default Modal;
+import React from "react";
+declare function Modal({ children, open, onCancel, disableEscKey, disableClose, enableBackgroundUI, timeout, ...rest }: {
+    [x: string]: any;
+    children: any;
+    open: any;
+    onCancel: any;
+    disableEscKey: any;
+    disableClose: any;
+    enableBackgroundUI: any;
+    timeout: any;
+}): JSX.Element;
+declare namespace Modal {
+    namespace propTypes {
+        const children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        const onCancel: PropTypes.Requireable<(...args: any[]) => any>;
+        const open: PropTypes.Validator<boolean>;
+        const enableBackgroundUI: PropTypes.Requireable<boolean>;
+        const disableEscKey: PropTypes.Requireable<boolean>;
+        const disableClose: PropTypes.Requireable<boolean>;
+        const timeout: PropTypes.Requireable<number>;
+    }
+    namespace defaultProps {
+        const onCancel_1: null;
+        export { onCancel_1 as onCancel };
+        const enableBackgroundUI_1: boolean;
+        export { enableBackgroundUI_1 as enableBackgroundUI };
+        const disableEscKey_1: boolean;
+        export { disableEscKey_1 as disableEscKey };
+        const timeout_1: number;
+        export { timeout_1 as timeout };
+    }
+}
+import PropTypes from "prop-types";

package/lib/components/modal/modal.d.ts

@@ -1,5 +1,14 @@
 import * as React from "react";
 
+export interface ModalContextProps {
+  value?: {
+    isInModal?: boolean;
+    isAnimationComplete?: boolean;
+    triggerRefocusFlag?: boolean;
+  };
+  ref?: React.MutableRefObject<React.ReactNode>;
+}
+
 export interface ModalProps {
   /** Modal content */
   children?: React.ReactNode;
@@ -19,6 +28,8 @@ export interface ModalProps {
   timeout?: number;
 }
 
+declare const ModelContext: React.Context<ModalContextProps>;
 declare function Modal(props: ModalProps): JSX.Element;
 
+export { ModalContext };
 export default Modal;

package/lib/components/modal/modal.style.d.ts

@@ -0,0 +1,2 @@
+export const StyledModal: import("styled-components").StyledComponent<"div", any, {}, never>;
+export const StyledModalBackground: import("styled-components").StyledComponent<"div", any, {}, never>;

package/lib/components/popover-container/index.d.ts

@@ -1 +1,2 @@
-export { default } from "./popover-container";
+export { default } from "./popover-container.component";
+export type { PopoverContainerProps, RenderCloseProps, RenderOpenProps, } from "./popover-container.component";

package/lib/components/popover-container/popover-container.component.d.ts

@@ -0,0 +1,56 @@
+import React from "react";
+import { PaddingProps } from "styled-system";
+export interface RenderOpenProps {
+    tabIndex: number;
+    isOpen?: boolean;
+    "data-element": string;
+    onClick: (ev: React.MouseEvent<HTMLElement>) => void;
+    ref: React.RefObject<HTMLButtonElement>;
+    "aria-label"?: string;
+    id?: string;
+}
+export interface RenderCloseProps {
+    "data-element": string;
+    tabIndex: number;
+    onClick: (ev: React.MouseEvent<HTMLElement>) => void;
+    ref: React.RefObject<HTMLButtonElement>;
+    "aria-label": string;
+}
+export interface PopoverContainerProps extends PaddingProps {
+    /** A function that will render the open component
+     *
+     * `({tabIndex, isOpen, data-element, onClick, ref, aria-label}) => ()`
+     *
+     */
+    renderOpenComponent?: (args: RenderOpenProps) => JSX.Element;
+    /** A function that will render the close component
+     *
+     * `({data-element, tabIndex, onClick, ref, aria-label}) => ()`
+     *
+     */
+    renderCloseComponent?: (args: RenderCloseProps) => JSX.Element;
+    /** The content of the popover-container */
+    children?: React.ReactNode;
+    /** Sets rendering position of dialog */
+    position?: "left" | "right";
+    /** Sets the popover container dialog header name */
+    title?: string;
+    /** Callback fires when close icon clicked */
+    onClose?: (ev: React.MouseEvent<HTMLElement>) => void;
+    /** if `true` the popover-container is open */
+    open?: boolean;
+    /** Callback fires when open component is clicked */
+    onOpen?: (ev: React.MouseEvent<HTMLElement>) => void;
+    /** if `true` the popover-container will cover open button */
+    shouldCoverButton?: boolean;
+    /** The id of the element that describe the dialog. */
+    ariaDescribedBy?: string;
+    /** Open button aria label */
+    openButtonAriaLabel?: string;
+    /** Close button aria label */
+    closeButtonAriaLabel?: string;
+    /** Container aria label */
+    containerAriaLabel?: string;
+}
+export declare const PopoverContainer: ({ children, title, position, open, onOpen, onClose, renderOpenComponent, renderCloseComponent, shouldCoverButton, ariaDescribedBy, openButtonAriaLabel, closeButtonAriaLabel, containerAriaLabel, ...rest }: PopoverContainerProps) => JSX.Element;
+export default PopoverContainer;