carbon-react 125.7.0 → 125.8.0

package/esm/__internal__/fieldset/fieldset.component.d.ts

@@ -22,6 +22,18 @@ export interface FieldsetProps extends MarginProps {
     isRequired?: boolean;
     /** Controls whether group behaviour should be enabled */
     blockGroupBehaviour?: boolean;
+    /** Margin props for the legend element */
+    legendMargin?: Pick<MarginProps, "mb">;
+    /** Any valid CSS string to set the component's width */
+    width?: string;
+    /** Flag to configure component as optional in Form */
+    isOptional?: boolean;
+    /** Apply disabled styling to the legend content */
+    isDisabled?: boolean;
+    /** Set a name value on the component */
+    name?: string;
+    /** Set an id value on the component */
+    id?: string;
 }
-declare const Fieldset: ({ legend, children, inline, legendWidth, legendAlign, legendSpacing, error, warning, info, isRequired, blockGroupBehaviour, ...rest }: FieldsetProps) => React.JSX.Element;
+declare const Fieldset: ({ legend, children, inline, legendWidth, legendAlign, legendSpacing, error, warning, info, isRequired, blockGroupBehaviour, legendMargin, isDisabled, isOptional, ...rest }: FieldsetProps) => React.JSX.Element;
 export default Fieldset;

package/esm/__internal__/fieldset/fieldset.component.js

@@ -1,5 +1,5 @@
 function _extends() { _extends = Object.assign ? Object.assign.bind() : 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, { useContext } from "react";
+import React, { useContext, useEffect, useState } from "react";
 import PropTypes from "prop-types";
 import { StyledFieldset, StyledLegend, StyledLegendContent } from "./fieldset.style";
 import ValidationIcon from "../validations/validation-icon.component";
@@ -18,28 +18,44 @@ const Fieldset = ({
   info,
   isRequired,
   blockGroupBehaviour,
+  legendMargin = {},
+  isDisabled,
+  isOptional,
   ...rest
 }) => {
   const {
     validationRedesignOptIn
   } = useContext(NewValidationContext);
   const marginProps = useFormSpacing(rest);
+  const [ref, setRef] = useState(null);
+  useEffect(() => {
+    if (ref && isRequired) {
+      Array.from(ref.querySelectorAll("input") || /* istanbul ignore next */[]).forEach(el => {
+        el.setAttribute("required", "");
+      });
+    }
+  }, [ref, isRequired]);
   return /*#__PURE__*/React.createElement(InputGroupBehaviour, {
     blockGroupBehaviour: blockGroupBehaviour
   }, /*#__PURE__*/React.createElement(StyledFieldset, _extends({
+    ref: setRef,
     "data-component": "fieldset"
   }, rest, marginProps), legend && /*#__PURE__*/React.createElement(InputGroupContext.Consumer, null, ({
     onMouseEnter,
     onMouseLeave
-  }) => /*#__PURE__*/React.createElement(StyledLegend, {
+  }) => /*#__PURE__*/React.createElement(StyledLegend, _extends({
     onMouseEnter: onMouseEnter,
     onMouseLeave: onMouseLeave,
     inline: inline,
     width: legendWidth,
     align: legendAlign,
     rightPadding: legendSpacing
-  }, /*#__PURE__*/React.createElement(StyledLegendContent, {
-    isRequired: isRequired
+  }, legendMargin, {
+    "data-element": "legend"
+  }), /*#__PURE__*/React.createElement(StyledLegendContent, {
+    isRequired: isRequired,
+    isOptional: isOptional,
+    isDisabled: isDisabled
   }, legend, !validationRedesignOptIn && /*#__PURE__*/React.createElement(ValidationIcon, {
     error: error,
     warning: warning,

package/esm/__internal__/fieldset/fieldset.style.d.ts

@@ -1,6 +1,11 @@
-declare const StyledFieldset: import("styled-components").StyledComponent<"fieldset", any, {}, never>;
+declare type StyledFieldsetProps = {
+    width?: string;
+};
+declare const StyledFieldset: import("styled-components").StyledComponent<"fieldset", any, StyledFieldsetProps, never>;
 declare type StyledLegendContentProps = {
     isRequired?: boolean;
+    isOptional?: boolean;
+    isDisabled?: boolean;
 };
 declare const StyledLegendContent: import("styled-components").StyledComponent<"span", any, StyledLegendContentProps, never>;
 declare type StyledLegendProps = {

package/esm/__internal__/fieldset/fieldset.style.js

@@ -8,6 +8,9 @@ const StyledFieldset = styled.fieldset`
   padding: 0;
   min-width: 0;
   min-inline-size: 0;
+  ${({
+  width
+}) => width && `width: ${width};`}
 `;
 StyledFieldset.defaultProps = {
   theme: BaseTheme
@@ -25,13 +28,35 @@ const StyledLegendContent = styled.span`
         color: var(--colorsSemanticNegative500);
         font-weight: 700;
         margin-left: var(--spacing100);
+        position: relative;
+        top: 1px;
+        left: -4px;
+      }
+    `}
+
+  ${({
+  isOptional
+}) => isOptional && css`
+      ::after {
+        content: "(optional)";
+        font-weight: 350; //TODO: (tokens) use token var(--fontWeights400) - FE-6022
+        margin-left: 4px;
+      }
+    `}
+
+  ${({
+  isDisabled
+}) => isDisabled && css`
+      color: var(--colorsUtilityYin030);
+      ::after {
+        color: var(--colorsUtilityYin030);
       }
     `}
 `;
 const StyledLegend = styled.legend`
   display: flex;
   align-items: center;
-  margin-bottom: 8px;
+  margin-bottom: var(--spacing100);
   padding: 0;
   font-weight: 600;
   ${({
@@ -47,5 +72,6 @@ const StyledLegend = styled.legend`
       justify-content: ${align === "right" ? "flex-end" : "flex-start"};
       padding-right: ${rightPadding === 1 ? "var(--spacing100)" : "var(--spacing200)"};
     `}
+  ${margin}
 `;
 export { StyledFieldset, StyledLegend, StyledLegendContent };

package/esm/__internal__/label/label.component.d.ts

@@ -20,7 +20,11 @@ export interface LabelProps extends ValidationProps, StyledLabelProps, StyledLab
     useValidationIcon?: boolean;
     /** Id of the validation icon */
     validationIconId?: string;
+    /** Sets className for component */
+    className?: string;
+    /** Sets aria-label for label element */
+    "aria-label"?: string;
 }
-export declare const Label: ({ align, as, children, disabled, error, help, helpIcon, htmlFor, info, inline, isRequired, labelId, optional, pr, pl, tooltipId, useValidationIcon, validationIconId, warning, width, }: LabelProps) => React.JSX.Element;
-declare const _default: React.MemoExoticComponent<({ align, as, children, disabled, error, help, helpIcon, htmlFor, info, inline, isRequired, labelId, optional, pr, pl, tooltipId, useValidationIcon, validationIconId, warning, width, }: LabelProps) => React.JSX.Element>;
+export declare const Label: ({ align, as, children, disabled, error, help, helpIcon, htmlFor, info, inline, isRequired, labelId, optional, pr, pl, tooltipId, useValidationIcon, validationIconId, warning, width, className, "aria-label": ariaLabel, }: LabelProps) => React.JSX.Element;
+declare const _default: React.MemoExoticComponent<({ align, as, children, disabled, error, help, helpIcon, htmlFor, info, inline, isRequired, labelId, optional, pr, pl, tooltipId, useValidationIcon, validationIconId, warning, width, className, "aria-label": ariaLabel, }: LabelProps) => React.JSX.Element>;
 export default _default;

package/esm/__internal__/label/label.component.js

@@ -43,7 +43,9 @@ export const Label = ({
   useValidationIcon = true,
   validationIconId,
   warning,
-  width = 30
+  width = 30,
+  className,
+  "aria-label": ariaLabel
 }) => {
   const [isFocused, setFocus] = useState(false);
   const {
@@ -100,7 +102,8 @@ export const Label = ({
     width: width,
     optional: optional,
     pr: pr,
-    pl: pl
+    pl: pl,
+    className: className
   }, /*#__PURE__*/React.createElement(StyledLabel, _extends({
     "data-element": "label",
     disabled: disabled,
@@ -111,7 +114,8 @@ export const Label = ({
     onMouseEnter: handleMouseEnter,
     onMouseLeave: handleMouseLeave,
     isRequired: isRequired,
-    as: as
+    as: as,
+    "aria-label": ariaLabel
   }), children), icon());
 };
 export default /*#__PURE__*/React.memo(Label);

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

@@ -45,6 +45,8 @@ export interface BoxProps extends SpaceProps, LayoutProps, FlexboxProps, Omit<Gr
     backgroundColor?: string;
     /** Set the opacity attribute of the Box component */
     opacity?: string | number;
+    /** Set the container to be hidden from screen readers */
+    "aria-hidden"?: "true" | "false";
 }
 export declare const Box: React.ForwardRefExoticComponent<BoxProps & React.RefAttributes<HTMLDivElement>>;
 export default Box;

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

@@ -24,6 +24,7 @@ const Box = /*#__PURE__*/React.forwardRef(({
   borderRadius,
   color,
   opacity,
+  "aria-hidden": ariaHidden,
   ...rest
 }, ref) => {
   return /*#__PURE__*/React.createElement(StyledBox, _extends({
@@ -44,7 +45,8 @@ const Box = /*#__PURE__*/React.forwardRef(({
     boxShadow: boxShadow,
     borderRadius: borderRadius,
     color: color,
-    opacity: opacity
+    opacity: opacity,
+    "aria-hidden": ariaHidden
   }, tagComponent(dataComponent, rest), filterStyledSystemMarginProps(rest), filterStyledSystemPaddingProps(rest), filterStyledSystemFlexboxProps(rest), filterStyledSystemGridProps(rest), filterStyledSystemLayoutProps(rest)), children);
 });
 Box.propTypes = {
@@ -351,6 +353,7 @@ Box.propTypes = {
     "trimStart": PropTypes.func.isRequired,
     "valueOf": PropTypes.func.isRequired
   })]),
+  "aria-hidden": PropTypes.oneOf(["false", "true"]),
   "as": PropTypes.oneOfType([PropTypes.oneOf(["a", "abbr", "address", "animate", "animateMotion", "animateTransform", "area", "article", "aside", "audio", "b", "base", "bdi", "bdo", "big", "blockquote", "body", "br", "button", "canvas", "caption", "circle", "cite", "clipPath", "code", "col", "colgroup", "data", "datalist", "dd", "defs", "del", "desc", "details", "dfn", "dialog", "div", "dl", "dt", "ellipse", "em", "embed", "feBlend", "feColorMatrix", "feComponentTransfer", "feComposite", "feConvolveMatrix", "feDiffuseLighting", "feDisplacementMap", "feDistantLight", "feDropShadow", "feFlood", "feFuncA", "feFuncB", "feFuncG", "feFuncR", "feGaussianBlur", "feImage", "feMerge", "feMergeNode", "feMorphology", "feOffset", "fePointLight", "feSpecularLighting", "feSpotLight", "feTile", "feTurbulence", "fieldset", "figcaption", "figure", "filter", "footer", "foreignObject", "form", "g", "h1", "h2", "h3", "h4", "h5", "h6", "head", "header", "hgroup", "hr", "html", "i", "iframe", "image", "img", "input", "ins", "kbd", "keygen", "label", "legend", "li", "line", "linearGradient", "link", "main", "map", "mark", "marker", "mask", "menu", "menuitem", "meta", "metadata", "meter", "mpath", "nav", "noindex", "noscript", "object", "ol", "optgroup", "option", "output", "p", "param", "path", "pattern", "picture", "polygon", "polyline", "pre", "progress", "q", "radialGradient", "rect", "rp", "rt", "ruby", "s", "samp", "script", "section", "select", "slot", "small", "source", "span", "stop", "strong", "style", "sub", "summary", "sup", "svg", "switch", "symbol", "table", "tbody", "td", "template", "text", "textarea", "textPath", "tfoot", "th", "thead", "time", "title", "tr", "track", "tspan", "u", "ul", "use", "var", "video", "view", "wbr", "webview"]), PropTypes.func, PropTypes.shape({
     "childContextTypes": PropTypes.object,
     "contextType": PropTypes.shape({

package/esm/components/button-toggle/button-toggle-group/button-toggle-group.component.d.ts

@@ -44,6 +44,11 @@ export interface ButtonToggleGroupProps extends MarginProps, TagProps {
     helpAriaLabel?: string;
     /** set this to true to allow the buttons within the group to be deselected when already selected, leaving no selected button */
     allowDeselect?: boolean;
+    /**
+     * @private @ignore
+     * Set a class on the component
+     */
+    className?: string;
 }
 declare type ButtonToggleGroupContextType = {
     onButtonClick: (value: string) => void;
@@ -58,7 +63,7 @@ declare type ButtonToggleGroupContextType = {
 };
 export declare const ButtonToggleGroupContext: React.Context<ButtonToggleGroupContextType>;
 declare const ButtonToggleGroup: {
-    ({ children, fieldHelp, fieldHelpInline, "aria-label": ariaLabel, label, labelHelp, labelSpacing, inputWidth, fullWidth, labelInline, labelWidth, labelAlign, name, onChange, value, "data-component": dataComponent, "data-element": dataElement, "data-role": dataRole, helpAriaLabel, id, allowDeselect, ...props }: ButtonToggleGroupProps): React.JSX.Element;
+    ({ children, fieldHelp, fieldHelpInline, "aria-label": ariaLabel, label, labelHelp, labelSpacing, inputWidth, fullWidth, labelInline, labelWidth, labelAlign, name, onChange, value, "data-component": dataComponent, "data-element": dataElement, "data-role": dataRole, helpAriaLabel, id, allowDeselect, className, ...props }: ButtonToggleGroupProps): React.JSX.Element;
     displayName: string;
 };
 export default ButtonToggleGroup;

package/esm/components/button-toggle/button-toggle-group/button-toggle-group.component.js

@@ -42,6 +42,7 @@ const ButtonToggleGroup = ({
   helpAriaLabel,
   id,
   allowDeselect,
+  className,
   ...props
 }) => {
   const hasCorrectItemStructure = useMemo(() => {
@@ -152,7 +153,9 @@ const ButtonToggleGroup = ({
     "data-role": dataRole,
     "data-element": dataElement,
     id: id
-  }, filterStyledSystemMarginProps(props)), children))))));
+  }, filterStyledSystemMarginProps(props), {
+    className: className
+  }), children))))));
 };
 ButtonToggleGroup.displayName = "ButtonToggleGroup";
 export default ButtonToggleGroup;

package/esm/components/button-toggle/button-toggle.style.d.ts

@@ -1,5 +1,20 @@
 import { IconType } from "../icon";
 export declare type ButtonToggleIconSizes = "small" | "large";
+export declare const heightConfig: {
+    small: number;
+    medium: number;
+    large: number;
+};
+export declare const fontSizeConfig: {
+    small: number;
+    medium: number;
+    large: number;
+};
+export declare const paddingConfig: {
+    small: number;
+    medium: number;
+    large: number;
+};
 declare const StyledButtonToggleContentWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
 export interface StyledButtonToggleProps {
     /** The icon to be rendered inside of the button */

package/esm/components/button-toggle/button-toggle.style.js

@@ -2,17 +2,17 @@ import styled, { css } from "styled-components";
 import StyledIcon from "../icon/icon.style";
 import addFocusStyling from "../../style/utils/add-focus-styling";
 import baseTheme from "../../style/themes/base";
-const heightConfig = {
+export const heightConfig = {
   small: 32,
   medium: 40,
   large: 48
 };
-const fontSizeConfig = {
+export const fontSizeConfig = {
   small: 14,
   medium: 14,
   large: 16
 };
-const paddingConfig = {
+export const paddingConfig = {
   small: 16,
   medium: 24,
   large: 32

package/esm/components/heading/heading.style.d.ts

@@ -12,7 +12,7 @@ declare type StyledHeadingTitleProps = {
     withMargin?: boolean;
 };
 declare const StyledHeadingTitle: import("styled-components").StyledComponent<{
-    ({ "data-component": dataComponent, variant, as, id, fontSize, fontWeight, textTransform, lineHeight, textDecoration, display, listStyleType, whiteSpace, wordWrap, textAlign, textOverflow, truncate, color, backgroundColor, bg, opacity, children, className, screenReaderOnly, ...rest }: import("../typography").TypographyProps): import("react").JSX.Element;
+    ({ "data-component": dataComponent, variant, as, id, fontSize, fontWeight, textTransform, lineHeight, textDecoration, display, listStyleType, whiteSpace, wordWrap, textAlign, textOverflow, truncate, color, backgroundColor, bg, opacity, children, className, screenReaderOnly, isDisabled, ...rest }: import("../typography").TypographyProps): import("react").JSX.Element;
     displayName: string;
 }, any, StyledHeadingTitleProps, never>;
 declare const StyledHeadingPills: import("styled-components").StyledComponent<"span", any, {}, never>;

package/esm/components/tile/flex-tile-cell/flex-tile-cell.component.js

@@ -325,6 +325,7 @@ FlexTileCell.propTypes = {
     "trimStart": PropTypes.func.isRequired,
     "valueOf": PropTypes.func.isRequired
   })]),
+  "aria-hidden": PropTypes.oneOf(["false", "true"]),
   "as": PropTypes.oneOfType([PropTypes.oneOf(["a", "abbr", "address", "animate", "animateMotion", "animateTransform", "area", "article", "aside", "audio", "b", "base", "bdi", "bdo", "big", "blockquote", "body", "br", "button", "canvas", "caption", "circle", "cite", "clipPath", "code", "col", "colgroup", "data", "datalist", "dd", "defs", "del", "desc", "details", "dfn", "dialog", "div", "dl", "dt", "ellipse", "em", "embed", "feBlend", "feColorMatrix", "feComponentTransfer", "feComposite", "feConvolveMatrix", "feDiffuseLighting", "feDisplacementMap", "feDistantLight", "feDropShadow", "feFlood", "feFuncA", "feFuncB", "feFuncG", "feFuncR", "feGaussianBlur", "feImage", "feMerge", "feMergeNode", "feMorphology", "feOffset", "fePointLight", "feSpecularLighting", "feSpotLight", "feTile", "feTurbulence", "fieldset", "figcaption", "figure", "filter", "footer", "foreignObject", "form", "g", "h1", "h2", "h3", "h4", "h5", "h6", "head", "header", "hgroup", "hr", "html", "i", "iframe", "image", "img", "input", "ins", "kbd", "keygen", "label", "legend", "li", "line", "linearGradient", "link", "main", "map", "mark", "marker", "mask", "menu", "menuitem", "meta", "metadata", "meter", "mpath", "nav", "noindex", "noscript", "object", "ol", "optgroup", "option", "output", "p", "param", "path", "pattern", "picture", "polygon", "polyline", "pre", "progress", "q", "radialGradient", "rect", "rp", "rt", "ruby", "s", "samp", "script", "section", "select", "slot", "small", "source", "span", "stop", "strong", "style", "sub", "summary", "sup", "svg", "switch", "symbol", "table", "tbody", "td", "template", "text", "textarea", "textPath", "tfoot", "th", "thead", "time", "title", "tr", "track", "tspan", "u", "ul", "use", "var", "video", "view", "wbr", "webview"]), PropTypes.func, PropTypes.shape({
     "childContextTypes": PropTypes.object,
     "contextType": PropTypes.shape({

package/esm/components/time/__internal__/time-toggle/index.d.ts

@@ -0,0 +1,2 @@
+export { default as TimeToggle } from "./time-toggle.component";
+export type { ToggleProps, ToggleDataProps } from "./time-toggle.component";

package/esm/components/time/__internal__/time-toggle/index.js

@@ -0,0 +1 @@
+export { default as TimeToggle } from "./time-toggle.component";

package/esm/components/time/__internal__/time-toggle/time-toggle.component.d.ts

@@ -0,0 +1,20 @@
+import React from "react";
+import { TagProps } from "../../../../__internal__/utils/helpers/tags";
+import { ToggleValue } from "../../time.component";
+export interface ToggleDataProps {
+    wrapperProps?: Omit<TagProps, "data-component">;
+    amToggleProps?: Omit<TagProps, "data-component">;
+    pmToggleProps?: Omit<TagProps, "data-component">;
+}
+export interface ToggleProps extends Omit<TagProps, "data-component"> {
+    size?: "small" | "medium" | "large";
+    onChange: (pressedValue: ToggleValue) => void;
+    toggleValue: ToggleValue;
+    disabled?: boolean;
+    toggleProps?: ToggleDataProps;
+}
+declare const Toggle: {
+    ({ size, onChange, toggleValue, disabled, toggleProps, }: ToggleProps): React.JSX.Element;
+    displayName: string;
+};
+export default Toggle;

package/esm/components/time/__internal__/time-toggle/time-toggle.component.js

@@ -0,0 +1,52 @@
+function _extends() { _extends = Object.assign ? Object.assign.bind() : 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, { useRef, useCallback } from "react";
+import PropTypes from "prop-types";
+import guid from "../../../../__internal__/utils/helpers/guid";
+import useLocale from "../../../../hooks/__internal__/useLocale";
+import ButtonToggleGroup from "./time-toggle.style";
+import { ButtonToggle } from "../../../button-toggle";
+const Toggle = ({
+  size,
+  onChange,
+  toggleValue,
+  disabled,
+  toggleProps
+}) => {
+  const locale = useLocale();
+  const amText = locale.time.amText();
+  const pmText = locale.time.pmText();
+  const internalId = useRef(guid());
+  const {
+    wrapperProps,
+    amToggleProps,
+    pmToggleProps
+  } = toggleProps || /* istanbul ignore next */{};
+  const handleChange = useCallback(event => {
+    const selectedButtonValue = event.target.value;
+    if (selectedButtonValue !== toggleValue) {
+      onChange(selectedButtonValue);
+    }
+  }, [toggleValue, onChange]);
+  return /*#__PURE__*/React.createElement(ButtonToggleGroup, _extends({}, wrapperProps, {
+    "data-component": "time-button-toggle-group",
+    m: "0px 0px 0px 8px",
+    id: internalId.current,
+    onChange: handleChange,
+    value: toggleValue,
+    disabled: disabled
+  }), /*#__PURE__*/React.createElement(ButtonToggle, _extends({}, amToggleProps, {
+    "data-component": "am-button-toggle",
+    grouped: true,
+    value: "AM",
+    size: size,
+    disabled: disabled
+  }), amText), /*#__PURE__*/React.createElement(ButtonToggle, _extends({}, pmToggleProps, {
+    "data-component": "pm-button-toggle",
+    grouped: true,
+    value: "PM",
+    size: size,
+    disabled: disabled
+  }), pmText));
+};
+Toggle.displayName = "Toggle";
+export default Toggle;

package/esm/components/time/__internal__/time-toggle/time-toggle.style.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+declare const _default: import("styled-components").StyledComponent<{
+    ({ children, fieldHelp, fieldHelpInline, "aria-label": ariaLabel, label, labelHelp, labelSpacing, inputWidth, fullWidth, labelInline, labelWidth, labelAlign, name, onChange, value, "data-component": dataComponent, "data-element": dataElement, "data-role": dataRole, helpAriaLabel, id, allowDeselect, className, ...props }: import("../../../button-toggle").ButtonToggleGroupProps): import("react").JSX.Element;
+    displayName: string;
+}, any, {
+    disabled?: boolean | undefined;
+}, never>;
+export default _default;

package/esm/components/time/__internal__/time-toggle/time-toggle.style.js

@@ -0,0 +1,19 @@
+import styled, { css } from "styled-components";
+import { ButtonToggleGroup } from "../../../button-toggle";
+
+// TODO this can be removed as part of FE-6335
+export default styled(ButtonToggleGroup)`
+  ${({
+  disabled
+}) => disabled && css`
+      opacity: 0.3;
+
+      [aria-pressed="true"] {
+        cursor: not-allowed;
+        :hover {
+          background-color: transparent;
+          box-shadow: inset 0px 0px 0px 3px var(--colorsActionMinor500);
+        }
+      }
+    `}
+`;

package/esm/components/time/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Time } from "./time.component";
+export type { TimeValue, TimeProps, TimeHandle, ToggleValue, } from "./time.component";

package/esm/components/time/index.js

@@ -0,0 +1 @@
+export { default as Time } from "./time.component";

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

@@ -0,0 +1,73 @@
+import React from "react";
+import { MarginProps } from "styled-system";
+import { ValidationProps } from "../../__internal__/validations";
+import { TagProps } from "../../__internal__/utils/helpers/tags";
+import { Sizes } from "../../__internal__/input/input-presentation.component";
+import { ToggleDataProps } from "./__internal__/time-toggle";
+export declare type ToggleValue = "AM" | "PM";
+export declare type TimeValue = {
+    hours: string;
+    minutes: string;
+    period?: ToggleValue;
+};
+export interface TimeInputEvent {
+    target: {
+        name?: string;
+        id: string;
+        value: TimeValue;
+    };
+}
+interface TimeInputProps extends Omit<TagProps, "data-component">, Omit<ValidationProps, "info"> {
+    /** Set an id value on the input */
+    id?: string;
+    /** Override the default label text */
+    label?: string;
+    /** Override the default aria-label text */
+    "aria-label"?: string;
+}
+export interface TimeProps extends Omit<TagProps, "data-component">, MarginProps {
+    /** Label text for the component */
+    label?: string;
+    /** Sets the size of the inputs */
+    size?: Sizes;
+    /** Additional hint text rendered above the input elements */
+    inputHint?: string;
+    /**
+     * Set custom `data-` and `id` attributes on the input element.
+     * Set the `label` and `aria-label` values for the associated Label element.
+     * Set the `error` and `warning` states for the input
+     *  */
+    hoursInputProps?: TimeInputProps;
+    /**
+     * Set custom `data-` and `id` attributes on the input element.
+     * Set the `label` and `aria-label` values for the associated Label element.
+     * Set the `error` and `warning` states for the input
+     *  */
+    minutesInputProps?: TimeInputProps;
+    /** The value of the input elements */
+    value: TimeValue;
+    /** Callback to handle change events in input elements */
+    onChange: (ev: TimeInputEvent) => void;
+    /** Set a name value on the component */
+    name?: string;
+    /** Callback called when focus is lost on input elements */
+    onBlur?: (ev?: React.FocusEvent<HTMLInputElement>) => void;
+    /** Flag to configure component as mandatory */
+    required?: boolean;
+    /** Flag to configure component as optional */
+    isOptional?: boolean;
+    /** If true, the component will be disabled */
+    disabled?: boolean;
+    /** If true, the component will be read-only */
+    readOnly?: boolean;
+    /** Set custom data- attributes on the toggle elements */
+    toggleProps?: ToggleDataProps;
+}
+export declare type TimeHandle = {
+    /** Programmatically focus the hours input. */
+    focusHoursInput: () => void;
+    /** Programmatically focus the minutes input. */
+    focusMinutesInput: () => void;
+} | null;
+declare const Time: React.ForwardRefExoticComponent<TimeProps & React.RefAttributes<TimeHandle>>;
+export default Time;