carbon-react 110.1.2 → 110.2.1

package/esm/__internal__/character-count/character-count.component.d.ts

@@ -1,26 +1,9 @@
-declare var _default: React.ForwardRefExoticComponent<{
-    [x: string]: any;
-    [x: number]: any;
-} & {
-    theme?: any;
-}>;
-export default _default;
-import React from "react";
-export function CharacterCount({ value, limit, theme, ...props }: {
-    [x: string]: any;
-    value: any;
-    limit: any;
-    theme: any;
-}): JSX.Element;
-export namespace CharacterCount {
-    namespace propTypes {
-        const value: PropTypes.Validator<string>;
-        const limit: PropTypes.Validator<string>;
-        const theme: PropTypes.Requireable<object>;
-    }
-    namespace defaultProps {
-        export { baseTheme as theme };
-    }
+/// <reference types="react" />
+interface CharacterCountProps {
+    value: string;
+    limit: string;
+    isOverLimit: boolean;
+    "data-element"?: string;
 }
-import PropTypes from "prop-types";
-import baseTheme from "../../style/themes/base";
+declare const CharacterCount: ({ value, limit, isOverLimit, "data-element": dataElement, }: CharacterCountProps) => JSX.Element;
+export default CharacterCount;

package/esm/__internal__/character-count/character-count.component.js

@@ -1,28 +1,22 @@
-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); }
-
 import React from "react";
 import PropTypes from "prop-types";
-import { withTheme } from "styled-components";
-import baseTheme from "../../style/themes/base";
 import StyledCharacterCount from "./character-count.style";
 
 const CharacterCount = ({
   value,
   limit,
-  theme,
-  ...props
-}) => /*#__PURE__*/React.createElement(StyledCharacterCount, _extends({
-  theme: theme,
-  "aria-live": "polite"
-}, props), `${value}/${limit}`);
+  isOverLimit,
+  "data-element": dataElement
+}) => /*#__PURE__*/React.createElement(StyledCharacterCount, {
+  "aria-live": "polite",
+  isOverLimit: isOverLimit,
+  "data-element": dataElement
+}, `${value}/${limit}`);
 
 CharacterCount.propTypes = {
-  value: PropTypes.string.isRequired,
-  limit: PropTypes.string.isRequired,
-  theme: PropTypes.object
-};
-CharacterCount.defaultProps = {
-  theme: baseTheme
+  "data-element": PropTypes.string,
+  "isOverLimit": PropTypes.bool.isRequired,
+  "limit": PropTypes.string.isRequired,
+  "value": PropTypes.string.isRequired
 };
-export default withTheme(CharacterCount);
-export { CharacterCount };
+export default CharacterCount;

package/esm/__internal__/character-count/character-count.style.d.ts

@@ -1,2 +1,4 @@
+declare const StyledCharacterCount: import("styled-components").StyledComponent<"div", any, {
+    isOverLimit: boolean;
+}, never>;
 export default StyledCharacterCount;
-declare const StyledCharacterCount: import("styled-components").StyledComponent<"div", any, {}, never>;

package/esm/__internal__/character-count/character-count.style.js

@@ -1,4 +1,5 @@
 import styled, { css } from "styled-components";
+import baseTheme from "../../style/themes/base";
 const StyledCharacterCount = styled.div`
   text-align: right;
   font-size: 12px;
@@ -14,4 +15,7 @@ const StyledCharacterCount = styled.div`
       font-weight: 700;
     `}
 `;
+StyledCharacterCount.defaultProps = {
+  theme: baseTheme
+};
 export default StyledCharacterCount;

package/esm/__internal__/form-field/form-field.component.d.ts

@@ -32,6 +32,10 @@ interface CommonFormFieldProps extends MarginProps, ValidationProps {
     reverse?: boolean;
     /** Id of the validation icon */
     validationIconId?: string;
+    /**
+     * @private @ignore
+     * Flag dedicating if latest validation design should be used */
+    validationRedesignOptIn?: boolean;
 }
 export interface FormFieldProps extends CommonFormFieldProps, TagProps {
     /** Breakpoint for adaptive label (inline labels change to top aligned). Enables the adaptive behaviour when set */
@@ -53,7 +57,7 @@ export interface FormFieldProps extends CommonFormFieldProps, TagProps {
     useValidationIcon?: boolean;
 }
 declare const FormField: {
-    ({ children, disabled, fieldHelp: fieldHelpContent, fieldHelpInline, error, warning, info, tooltipId, fieldHelpId, label, labelId, labelAlign, labelHelp, labelHelpIcon, labelInline, labelSpacing, labelWidth, id, reverse, isOptional, useValidationIcon, adaptiveLabelBreakpoint, isRequired, validationIconId, ...rest }: FormFieldProps): JSX.Element;
+    ({ children, "data-component": dataComponent, disabled, fieldHelp: fieldHelpContent, fieldHelpInline, error, warning, info, tooltipId, fieldHelpId, label, labelId, labelAlign, labelHelp, labelHelpIcon, labelInline, labelSpacing, labelWidth, id, reverse, isOptional, useValidationIcon, adaptiveLabelBreakpoint, isRequired, validationIconId, validationRedesignOptIn, ...rest }: FormFieldProps): JSX.Element;
     displayName: string;
 };
 export default FormField;

package/esm/__internal__/form-field/form-field.component.js

@@ -13,6 +13,7 @@ import useIsAboveBreakpoint from "../../hooks/__internal__/useIsAboveBreakpoint"
 
 const FormField = ({
   children,
+  "data-component": dataComponent,
   disabled,
   fieldHelp: fieldHelpContent,
   fieldHelpInline,
@@ -36,6 +37,7 @@ const FormField = ({
   adaptiveLabelBreakpoint,
   isRequired,
   validationIconId,
+  validationRedesignOptIn,
   ...rest
 }) => {
   const invalidValidationProp = useMemo(() => {
@@ -71,15 +73,15 @@ const FormField = ({
     labelWidth: labelWidth,
     id: fieldHelpId
   }, fieldHelpContent) : null;
-  return /*#__PURE__*/React.createElement(FormFieldStyle, _extends({}, tagComponent(rest["data-component"], rest), marginProps), /*#__PURE__*/React.createElement(FieldLineStyle, {
+  return /*#__PURE__*/React.createElement(FormFieldStyle, _extends({}, tagComponent(dataComponent, rest), marginProps), /*#__PURE__*/React.createElement(FieldLineStyle, {
     inline: inlineLabel
   }, reverse && children, label && /*#__PURE__*/React.createElement(Label, {
     labelId: labelId,
     align: labelAlign,
     disabled: disabled,
-    error: !rest.validationRedesignOptIn && error,
-    warning: !rest.validationRedesignOptIn && warning,
-    info: !rest.validationRedesignOptIn && info,
+    error: !validationRedesignOptIn && error,
+    warning: !validationRedesignOptIn && warning,
+    info: !validationRedesignOptIn && info,
     help: labelHelp,
     tooltipId: tooltipId,
     htmlFor: id,
@@ -98,7 +100,7 @@ const FormField = ({
 FormField.propTypes = {
   "adaptiveLabelBreakpoint": PropTypes.number,
   "children": PropTypes.node,
-  "data-component": PropTypes.string.isRequired,
+  "data-component": PropTypes.string,
   "data-element": PropTypes.string,
   "data-role": PropTypes.string,
   "disabled": PropTypes.bool,
@@ -276,6 +278,7 @@ FormField.propTypes = {
   "tooltipId": PropTypes.string,
   "useValidationIcon": PropTypes.bool,
   "validationIconId": PropTypes.string,
+  "validationRedesignOptIn": PropTypes.bool,
   "warning": PropTypes.oneOfType([PropTypes.string, PropTypes.bool])
 };
 FormField.displayName = "FormField";

package/esm/__internal__/input/index.d.ts

@@ -1,5 +1,5 @@
 import Input from "./input.component";
 import InputPresentation from "./input-presentation.component";
-export type { InputProps } from "./input.component";
+export type { InputProps, CommonInputProps } from "./input.component";
 export { Input, InputPresentation };
 export default Input;

package/esm/__internal__/utils/helpers/tags/tags.d.ts

@@ -1,13 +1,16 @@
 interface DataProps {
+    /** Identifier used for testing purposes, applied to the root element of the component. */
     "data-element"?: string;
+    /** Identifier used for testing purposes, applied to the root element of the component. */
     "data-role"?: string;
     [restKeys: string]: any;
 }
 export interface TagProps extends DataProps {
-    "data-component": string;
+    /** Identifier used for testing purposes, applied to the root element of the component. */
+    "data-component"?: string;
 }
 /**
  * Builds props object containing top level data tags
  */
-declare function tagComponent(componentName: string, props: DataProps): TagProps;
+declare function tagComponent(componentName: string | undefined, props: DataProps): TagProps;
 export default tagComponent;

package/esm/__spec_helper__/test-utils.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { ReactWrapper, ShallowWrapper } from "enzyme";
-import { LayoutProps, FlexboxProps, BackgroundProps } from "styled-system";
+import { LayoutProps, FlexboxProps, BackgroundProps, PositionProps } from "styled-system";
 import { ReactTestRendererJSON } from "react-test-renderer";
 import { mockMatchMedia } from "./mock-match-media";
 declare const toCSSCase: (str: string) => string;
@@ -47,5 +47,6 @@ declare const testStyledSystemWidth: (component: (widthProperties?: {
 declare const testStyledSystemLayout: (component: (layoutProperties?: LayoutProps<Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined) => JSX.Element, styleContainer?: ((wrapper: ReactWrapper) => ReactWrapper) | undefined) => void;
 declare const testStyledSystemFlexBox: (component: (flexboxProperties?: FlexboxProps<Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined) => JSX.Element, styleContainer?: ((wrapper: ReactWrapper) => ReactWrapper) | undefined) => void;
 declare const testStyledSystemBackground: (component: (backgroundProperties?: BackgroundProps<Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>, import("csstype").Property.Background<import("styled-system").TLengthStyledSystem>> | undefined) => JSX.Element, styleContainer?: ((wrapper: ReactWrapper) => ReactWrapper) | undefined) => void;
+declare const testStyledSystemPosition: (component: (positionProperties?: PositionProps<Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined) => JSX.Element, styleContainer?: ((wrapper: ReactWrapper) => ReactWrapper) | undefined) => void;
 declare const expectConsoleOutput: (message: string, type?: "warn" | "error") => () => void;
-export { assertStyleMatch, toCSSCase, hoverList, selectedItemOf, childrenFrom, makeArrayKeys, keyboard, assertKeyboardTraversal, assertHoverTraversal, listFrom, click, simulate, carbonThemesJestTable, mockMatchMedia, testStyledSystemSpacing, testStyledSystemMargin, testStyledSystemPadding, testStyledSystemColor, testStyledSystemWidth, testStyledSystemLayout, testStyledSystemFlexBox, testStyledSystemBackground, expectConsoleOutput, };
+export { assertStyleMatch, toCSSCase, hoverList, selectedItemOf, childrenFrom, makeArrayKeys, keyboard, assertKeyboardTraversal, assertHoverTraversal, listFrom, click, simulate, carbonThemesJestTable, mockMatchMedia, testStyledSystemSpacing, testStyledSystemMargin, testStyledSystemPadding, testStyledSystemColor, testStyledSystemWidth, testStyledSystemLayout, testStyledSystemFlexBox, testStyledSystemBackground, testStyledSystemPosition, expectConsoleOutput, };

package/esm/__spec_helper__/test-utils.js

@@ -109,6 +109,7 @@ const widthProps = ["width", "width", "200px"];
 const layoutProps = [widthProps, ["height", "height", "200px"], ["minWidth", "min-width", "120px"], ["maxWidth", "max-width", "120px"], ["minHeight", "min-height", "120px"], ["maxHeight", "max-height", "120px"], ["size", "width", "120px"], ["size", "height", "120px"], ["display", "display", "inline-block"], ["verticalAlign", "vertical-align", "baseline"], ["overflow", "overflow", "hidden"], ["overflowX", "overflow-x", "hidden"], ["overflowY", "overflow-y", "hidden"]];
 const flexBoxProps = [["alignItems", "alignItems", "center"], ["alignContent", "alignContent", "center"], ["justifyItems", "justifyItems", "center"], ["justifyContent", "justifyContent", "center"], ["flexWrap", "flexWrap", "wrap"], ["flexDirection", "flexDirection", "row-reverse"], ["flex", "flex", "1"], ["flexGrow", "flexGrow", "1"], ["flexShrink", "flexShrink", "1"], ["flexBasis", "flexBasis", "100px"], ["justifySelf", "justifySelf", "center"], ["alignSelf", "alignSelf", "center"], ["order", "order", "1"]];
 const backgroundProps = [["background", "background", "lightblue url('foo.jpg') no-repeat fixed center"], ["backgroundImage", "background-image", "url(foo.jpg)"], ["backgroundSize", "background-size", "center"], ["backgroundRepeat", "background-repeat", "no-repeat"]];
+const positionProps = [["top", "0px"], ["bottom", "0px"], ["right", "0px"], ["left", "0px"], ["position", "fixed"], ["position", "sticky"], ["position", "absolute"], ["position", "static"], ["position", "relative"]];
 export const getDefaultValue = value => {
   const spaceArrayLength = space.length - 1;
   if (value === undefined) return value;
@@ -302,6 +303,21 @@ const testStyledSystemBackground = (component, styleContainer) => {
       }, styleContainer ? styleContainer(wrapper) : wrapper);
     });
   });
+};
+
+const testStyledSystemPosition = (component, styleContainer) => {
+  describe.each(positionProps)('when a prop is specified using the "%s" styled system props', (styledSystemProp, value) => {
+    it(`then ${styledSystemProp} should have been set correctly`, () => {
+      const props = {
+        [styledSystemProp]: value
+      };
+      const wrapper = mount(component({ ...props
+      }));
+      assertStyleMatch({
+        [styledSystemProp]: value
+      }, styleContainer ? styleContainer(wrapper) : wrapper);
+    });
+  });
 }; // this util will catch that a console output occurred without polluting the output when running the unit tests
 
 
@@ -335,4 +351,4 @@ const expectConsoleOutput = (message, type = "error") => {
   };
 };
 
-export { assertStyleMatch, toCSSCase, hoverList, selectedItemOf, childrenFrom, makeArrayKeys, keyboard, assertKeyboardTraversal, assertHoverTraversal, listFrom, click, simulate, carbonThemesJestTable, mockMatchMedia, testStyledSystemSpacing, testStyledSystemMargin, testStyledSystemPadding, testStyledSystemColor, testStyledSystemWidth, testStyledSystemLayout, testStyledSystemFlexBox, testStyledSystemBackground, expectConsoleOutput };
+export { assertStyleMatch, toCSSCase, hoverList, selectedItemOf, childrenFrom, makeArrayKeys, keyboard, assertKeyboardTraversal, assertHoverTraversal, listFrom, click, simulate, carbonThemesJestTable, mockMatchMedia, testStyledSystemSpacing, testStyledSystemMargin, testStyledSystemPadding, testStyledSystemColor, testStyledSystemWidth, testStyledSystemLayout, testStyledSystemFlexBox, testStyledSystemBackground, testStyledSystemPosition, expectConsoleOutput };

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

@@ -1,9 +1,9 @@
 import React from "react";
-import { SpaceProps, LayoutProps, FlexboxProps, ColorProps } from "styled-system";
+import { SpaceProps, LayoutProps, FlexboxProps, ColorProps, PositionProps } from "styled-system";
 export declare type OverflowWrap = "break-word" | "anywhere";
 export declare type ScrollVariant = "light" | "dark";
 export declare type BoxSizing = "content-box" | "border-box";
-export interface BoxProps extends SpaceProps, LayoutProps, FlexboxProps, ColorProps {
+export interface BoxProps extends SpaceProps, LayoutProps, FlexboxProps, ColorProps, Omit<PositionProps, "zIndex"> {
     as?: keyof JSX.IntrinsicElements | React.ComponentType<any>;
     /** String to set Box content break strategy. Note "anywhere" is not supported in Safari */
     overflowWrap?: OverflowWrap;
@@ -11,6 +11,8 @@ export interface BoxProps extends SpaceProps, LayoutProps, FlexboxProps, ColorPr
     scrollVariant?: ScrollVariant;
     /** set the box-sizing attribute of the Box component */
     boxSizing?: BoxSizing;
+    /** Allows a tabindex to be specified */
+    tabIndex?: number | string;
 }
 declare const Box: import("styled-components").StyledComponent<"div", any, BoxProps, never>;
 export default Box;

package/esm/components/box/box.component.js

@@ -1,5 +1,5 @@
 import styled, { css } from "styled-components";
-import { space, layout, flexbox } from "styled-system";
+import { space, layout, flexbox, position } from "styled-system";
 import BaseTheme from "../../style/themes/base";
 import styledColor from "../../style/utils/color";
 import boxConfig from "./box.config";
@@ -7,6 +7,7 @@ const Box = styled.div`
   ${space}
   ${layout}
   ${flexbox}
+  ${position}
   ${({
   color,
   bg,