carbon-react 106.6.6 → 106.6.9

package/esm/__internal__/utils/argTypes/specialCharacters.d.ts

@@ -0,0 +1,36 @@
+export declare const singleSpecialCharacters: {
+    options: string[];
+    mapping: {
+        minus: string;
+        questionMark: string;
+        hash: string;
+        at: string;
+        dollar: string;
+        percent: string;
+        caret: string;
+        exclamation: string;
+        asterisk: string;
+    };
+};
+export declare const email: {
+    options: string[];
+    mapping: {
+        email: string;
+    };
+};
+export declare const number: {
+    options: string[];
+    mapping: {
+        floatNumberCommaString: string;
+        floatMinusNumberCommaString: string;
+    };
+};
+declare const _default: {
+    options: string[];
+    mapping: {
+        undefined: undefined;
+        otherLanguage: string;
+        specialCharacters: string;
+    };
+};
+export default _default;

package/esm/__internal__/utils/argTypes/specialCharacters.js

@@ -0,0 +1,36 @@
+export const singleSpecialCharacters = {
+  options: ["minus", "questionMark", "hash", "at", "dollar", "percent", "caret", "exclamation", "asterisk"],
+  mapping: {
+    minus: "-",
+    questionMark: "?",
+    hash: "#",
+    at: "@",
+    dollar: "$",
+    percent: "%",
+    caret: "^",
+    exclamation: "!",
+    asterisk: "*"
+  }
+};
+export const email = {
+  options: ["email"],
+  mapping: {
+    email: "test.frontend.squad@gmail.com"
+  }
+};
+export const number = {
+  options: ["floatNumberCommaString", "floatMinusNumberCommaString"],
+  mapping: {
+    floatNumberCommaString: "0,112",
+    floatMinusNumberCommaString: "-0,112"
+  }
+};
+export default {
+  options: ["undefined", "otherLanguage", "specialCharacters"],
+  mapping: {
+    // eslint-disable-next-line object-shorthand
+    undefined: undefined,
+    otherLanguage: "mp150ú¿¡üßä",
+    specialCharacters: "!@#$%^*()_+-=~[];:.,?{}&\"'<>"
+  }
+};

package/esm/components/accordion/accordion-group/accordion-group.component.d.ts

@@ -1,24 +1,10 @@
-export default AccordionGroup;
-declare function AccordionGroup({ children, ...rest }: {
-    [x: string]: any;
-    children: any;
-}): JSX.Element;
-declare namespace AccordionGroup {
-    const propTypes: {
-        children: (props: any, propName: any, componentName: any) => undefined;
-        marginBottom?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        margin?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        m?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        marginLeft?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        ml?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        marginRight?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        mr?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        marginTop?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        mt?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        mb?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        marginX?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        mx?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        marginY?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-        my?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
-    };
+import React from "react";
+import { MarginProps } from "styled-system";
+declare type AccordionGroupChild = React.ReactElement | boolean | null | undefined | AccordionGroupChildArray;
+interface AccordionGroupChildArray extends Array<AccordionGroupChild> {
+}
+export interface AccordionGroupProps extends MarginProps {
+    children?: AccordionGroupChild;
 }
+export declare const AccordionGroup: ({ children, ...rest }: AccordionGroupProps) => JSX.Element;
+export default AccordionGroup;

package/esm/components/accordion/accordion-group/accordion-group.component.js

@@ -1,26 +1,43 @@
 import React, { useMemo, useCallback } from "react";
-import styledSystemPropTypes from "@styled-system/prop-types";
-import { filterStyledSystemMarginProps } from "../../../style/utils";
+import PropTypes from "prop-types";
+import invariant from "invariant";
 import Events from "../../../__internal__/utils/helpers/events";
-import Accordion from "../accordion.component.js";
-import { StyledAccordionGroup } from "../accordion.style.js";
-const marginProptypes = filterStyledSystemMarginProps(styledSystemPropTypes.space);
+import Accordion from "../accordion.component";
+import { StyledAccordionGroup } from "../accordion.style";
 
 const AccordionGroup = ({
   children,
   ...rest
 }) => {
-  const filteredChildren = useMemo(() => React.Children.toArray(children), [children]);
+  const hasProperChildren = useMemo(() => {
+    let hasAccordionChildren = true;
+    React.Children.toArray(children).forEach(child => {
+      if (typeof child === "string" || /*#__PURE__*/React.isValidElement(child) && child.type.displayName !== "Accordion") {
+        hasAccordionChildren = false;
+      }
+    });
+    return hasAccordionChildren;
+  }, [children]);
+  invariant(hasProperChildren, `AccordionGroup accepts only children of type \`${Accordion.displayName}\`.`);
+  const filteredChildren = useMemo(() => React.Children.toArray(children).filter(child => {
+    return /*#__PURE__*/React.isValidElement(child);
+  }), [children]);
   const refs = useMemo(() => filteredChildren.map(child => child.ref || /*#__PURE__*/React.createRef()), [filteredChildren]);
   const focusAccordion = useCallback((ev, index) => {
     ev.preventDefault();
 
     if (index === -1) {
-      refs[refs.length - 1].current.focus();
+      var _refs$current;
+
+      (_refs$current = refs[refs.length - 1].current) === null || _refs$current === void 0 ? void 0 : _refs$current.focus();
     } else if (index === refs.length) {
-      refs[0].current.focus();
+      var _refs$0$current;
+
+      (_refs$0$current = refs[0].current) === null || _refs$0$current === void 0 ? void 0 : _refs$0$current.focus();
     } else {
-      refs[index].current.focus();
+      var _refs$index$current;
+
+      (_refs$index$current = refs[index].current) === null || _refs$index$current === void 0 ? void 0 : _refs$index$current.focus();
     }
   }, [refs]);
   const handleKeyboardAccessibility = useCallback((ev, index) => {
@@ -40,27 +57,207 @@ const AccordionGroup = ({
       focusAccordion(ev, refs.length - 1);
     }
   }, [focusAccordion, refs]);
-  return /*#__PURE__*/React.createElement(StyledAccordionGroup, rest, filteredChildren.map((child, index) => /*#__PURE__*/React.cloneElement(child, {
+  return /*#__PURE__*/React.createElement(StyledAccordionGroup, rest, filteredChildren.map((child, index) =>
+  /*#__PURE__*/
+  // casted to ReactElement as there is no overload for an FunctionComponentElement in cloneElement
+  React.cloneElement(child, {
     ref: refs[index],
     index,
     handleKeyboardAccessibility
   })));
 };
 
-AccordionGroup.propTypes = { ...marginProptypes,
-  children: (props, propName, componentName) => {
-    let error;
-    const prop = props[propName];
-    React.Children.forEach(prop, child => {
-      if (!child) {
-        return;
-      }
-
-      if (Accordion.displayName !== child.type.displayName) {
-        error = new Error(`\`${componentName}\` only accepts children of type \`${Accordion.displayName}\`.`);
-      }
-    });
-    return error;
-  }
+AccordionGroup.propTypes = {
+  "children": PropTypes.oneOfType([PropTypes.element, PropTypes.shape({
+    "__@iterator": PropTypes.func.isRequired,
+    "__@unscopables": PropTypes.func.isRequired,
+    "concat": PropTypes.func.isRequired,
+    "copyWithin": PropTypes.func.isRequired,
+    "entries": PropTypes.func.isRequired,
+    "every": PropTypes.func.isRequired,
+    "fill": PropTypes.func.isRequired,
+    "filter": PropTypes.func.isRequired,
+    "find": PropTypes.func.isRequired,
+    "findIndex": PropTypes.func.isRequired,
+    "flat": PropTypes.func.isRequired,
+    "flatMap": PropTypes.func.isRequired,
+    "forEach": PropTypes.func.isRequired,
+    "includes": PropTypes.func.isRequired,
+    "indexOf": PropTypes.func.isRequired,
+    "join": PropTypes.func.isRequired,
+    "keys": PropTypes.func.isRequired,
+    "lastIndexOf": PropTypes.func.isRequired,
+    "length": PropTypes.number.isRequired,
+    "map": PropTypes.func.isRequired,
+    "pop": PropTypes.func.isRequired,
+    "push": PropTypes.func.isRequired,
+    "reduce": PropTypes.func.isRequired,
+    "reduceRight": PropTypes.func.isRequired,
+    "reverse": PropTypes.func.isRequired,
+    "shift": PropTypes.func.isRequired,
+    "slice": PropTypes.func.isRequired,
+    "some": PropTypes.func.isRequired,
+    "sort": PropTypes.func.isRequired,
+    "splice": PropTypes.func.isRequired,
+    "toLocaleString": PropTypes.func.isRequired,
+    "toString": PropTypes.func.isRequired,
+    "unshift": PropTypes.func.isRequired,
+    "values": PropTypes.func.isRequired
+  }), PropTypes.bool]),
+  "m": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "margin": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginBottom": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginLeft": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginRight": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginTop": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginX": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "marginY": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "mb": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "ml": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "mr": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "mt": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "mx": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string]),
+  "my": PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf([null]), PropTypes.number, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])), PropTypes.number, PropTypes.object, PropTypes.shape({
+    "__@toStringTag": PropTypes.string.isRequired,
+    "description": PropTypes.string,
+    "toString": PropTypes.func.isRequired,
+    "valueOf": PropTypes.func.isRequired
+  }), PropTypes.string])
 };
+export { AccordionGroup };
 export default AccordionGroup;

package/esm/components/accordion/accordion.component.d.ts

@@ -1,3 +1,45 @@
-export default Accordion;
-declare const Accordion: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
 import React from "react";
+import { SpaceProps } from "styled-system";
+import { StyledAccordionContainerProps } from "./accordion.style";
+export interface AccordionProps extends StyledAccordionContainerProps, SpaceProps {
+    /** Width of the buttonHeading when it's set, defaults to 150px */
+    buttonWidth?: number;
+    children?: React.ReactNode;
+    /** Set the default state of expansion of the Accordion if component is meant to be used as uncontrolled */
+    defaultExpanded?: boolean;
+    /** Disable padding for the content */
+    disableContentPadding?: boolean;
+    /** Sets the expansion state of the Accordion if component is meant to be used as controlled */
+    expanded?: boolean;
+    /** An error message to be displayed in the tooltip */
+    error?: string;
+    /** Styled system spacing props provided to Accordion Title */
+    headerSpacing?: SpaceProps;
+    id?: string;
+    /** Sets icon type - accepted values: 'chevron_down' (default), 'dropdown' */
+    iconType?: "chevron_down" | "dropdown";
+    /** Sets icon alignment - accepted values: 'left', 'right' (default) */
+    iconAlign?: "left" | "right";
+    /** Sets accordion title */
+    title: React.ReactNode;
+    /** An info message to be displayed in the tooltip */
+    info?: string;
+    /** Callback fired when expansion state changes */
+    onChange?: (event: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>, isExpanded: boolean) => void;
+    /** When the Accordion is open the title can change to this */
+    openTitle?: string;
+    /** Sets accordion size */
+    size?: "large" | "small";
+    /** Sets accordion sub title */
+    subTitle?: string;
+    /** A warning message to be displayed in the tooltip */
+    warning?: string;
+}
+export interface AccordionInternalProps {
+    /** @ignore @private */
+    handleKeyboardAccessibility?: (ev: React.KeyboardEvent<HTMLElement>, index?: number) => void;
+    /** @ignore @private */
+    index?: number;
+}
+export declare const Accordion: React.ForwardRefExoticComponent<AccordionProps & AccordionInternalProps & React.RefAttributes<HTMLDivElement>>;
+export default Accordion;