carbon-react 125.9.3 → 125.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/esm/components/heading/heading.style.d.ts +1 -1
  2. package/esm/components/pill/pill.component.d.ts +4 -2
  3. package/esm/components/pill/pill.component.js +28 -18
  4. package/esm/components/pill/pill.style.config.d.ts +3 -1
  5. package/esm/components/pill/pill.style.config.js +20 -10
  6. package/esm/components/pill/pill.style.d.ts +2 -1
  7. package/esm/components/pill/pill.style.js +4 -3
  8. package/esm/components/step-flow/index.d.ts +2 -0
  9. package/esm/components/step-flow/index.js +1 -0
  10. package/esm/components/step-flow/step-flow.component.d.ts +33 -0
  11. package/esm/components/step-flow/step-flow.component.js +277 -0
  12. package/esm/components/step-flow/step-flow.style.d.ts +12 -0
  13. package/esm/components/step-flow/step-flow.style.js +42 -0
  14. package/esm/components/typography/index.d.ts +1 -1
  15. package/esm/components/typography/typography.component.d.ts +3 -1
  16. package/esm/components/typography/typography.component.js +3 -1
  17. package/esm/locales/__internal__/pl-pl.js +5 -0
  18. package/esm/locales/en-gb.js +5 -0
  19. package/esm/locales/locale.d.ts +5 -0
  20. package/esm/style/design-tokens/debug-theme.util.d.ts +24 -5
  21. package/esm/style/themes/sage/index.d.ts +24 -5
  22. package/lib/components/heading/heading.style.d.ts +1 -1
  23. package/lib/components/pill/pill.component.d.ts +4 -2
  24. package/lib/components/pill/pill.component.js +28 -18
  25. package/lib/components/pill/pill.style.config.d.ts +3 -1
  26. package/lib/components/pill/pill.style.config.js +20 -10
  27. package/lib/components/pill/pill.style.d.ts +2 -1
  28. package/lib/components/pill/pill.style.js +4 -3
  29. package/lib/components/step-flow/index.d.ts +2 -0
  30. package/lib/components/step-flow/index.js +13 -0
  31. package/lib/components/step-flow/package.json +6 -0
  32. package/lib/components/step-flow/step-flow.component.d.ts +33 -0
  33. package/lib/components/step-flow/step-flow.component.js +285 -0
  34. package/lib/components/step-flow/step-flow.style.d.ts +12 -0
  35. package/lib/components/step-flow/step-flow.style.js +48 -0
  36. package/lib/components/typography/index.d.ts +1 -1
  37. package/lib/components/typography/typography.component.d.ts +3 -1
  38. package/lib/components/typography/typography.component.js +3 -1
  39. package/lib/locales/__internal__/pl-pl.js +5 -0
  40. package/lib/locales/en-gb.js +5 -0
  41. package/lib/locales/locale.d.ts +5 -0
  42. package/lib/style/design-tokens/debug-theme.util.d.ts +24 -5
  43. package/lib/style/themes/sage/index.d.ts +24 -5
  44. package/package.json +2 -4
@@ -52,6 +52,7 @@ declare const _default: {
52
52
  colorsActionMinor500: string;
53
53
  colorsActionMinor550: string;
54
54
  colorsActionMinor600: string;
55
+ colorsActionMinor700: string;
55
56
  colorsActionMinor850: string;
56
57
  colorsActionMinor900: string;
57
58
  colorsActionMinor025: string;
@@ -62,6 +63,7 @@ declare const _default: {
62
63
  colorsActionMinorYin065: string;
63
64
  colorsActionMinorYin090: string;
64
65
  colorsActionMinorYang100: string;
66
+ colorsActionMinorGray700: string;
65
67
  colorsActionDisabled400: string;
66
68
  colorsActionDisabled500: string;
67
69
  colorsActionDisabled600: string;
@@ -81,6 +83,7 @@ declare const _default: {
81
83
  colorsSemanticFocus250: string;
82
84
  colorsSemanticFocus500: string;
83
85
  colorsSemanticFocusTransparent: string;
86
+ colorsSemanticPositive400: string;
84
87
  colorsSemanticPositive500: string;
85
88
  colorsSemanticPositive600: string;
86
89
  colorsSemanticPositiveTransparent: string;
@@ -144,6 +147,8 @@ declare const _default: {
144
147
  colorsReadOnly500: string;
145
148
  colorsReadOnly600: string;
146
149
  colorsComponentsLeftnavWinterStandardBackground: string;
150
+ colorsComponentsLeftnavWinterStandardBackgroundChild: string;
151
+ colorsComponentsLeftnavWinterStandardDividerOnDark: string;
147
152
  colorsComponentsLeftnavWinterStandardHover: string;
148
153
  colorsComponentsLeftnavWinterStandardSelected: string;
149
154
  colorsComponentsLeftnavWinterStandardContent: string;
@@ -237,14 +242,21 @@ declare const _default: {
237
242
  sizing450: string;
238
243
  sizing500: string;
239
244
  sizing525: string;
245
+ sizing550: string;
240
246
  sizing600: string;
241
247
  sizing700: string;
242
248
  sizing800: string;
243
249
  sizing900: string;
244
250
  sizing1000: string;
251
+ sizing1100: string;
245
252
  sizing1200: string;
246
253
  sizing1300: string;
254
+ sizing1500: string;
247
255
  sizing1600: string;
256
+ sizing2000: string;
257
+ sizing2500: string;
258
+ sizing3000: string;
259
+ sizing7000: string;
248
260
  sizing010: string;
249
261
  sizing025: string;
250
262
  sizing050: string;
@@ -268,6 +280,7 @@ declare const _default: {
268
280
  spacing000: string;
269
281
  spacing010: string;
270
282
  spacing025: string;
283
+ spacing035: string;
271
284
  spacing050: string;
272
285
  spacing060: string;
273
286
  spacing075: string;
@@ -275,6 +288,7 @@ declare const _default: {
275
288
  spacingNeg025: string;
276
289
  spacingNeg050: string;
277
290
  spacingNeg075: string;
291
+ spacingNeg100: string;
278
292
  borderWidth100: string;
279
293
  borderWidth200: string;
280
294
  borderWidth300: string;
@@ -403,6 +417,11 @@ declare const _default: {
403
417
  typographyLinkTextFocusS: string;
404
418
  typographyLinkTextFocusM: string;
405
419
  typographyLinkTextFocusL: string;
420
+ typographyLoaderMessageXs: string;
421
+ typographyLoaderMessageS: string;
422
+ typographyLoaderMessageM: string;
423
+ typographyLoaderMessageL: string;
424
+ typographyLoaderMessageXl: string;
406
425
  typographyMenuLabelM: string;
407
426
  typographyMenuLabelL: string;
408
427
  typographyMenuSegmentTitleM: string;
@@ -410,6 +429,11 @@ declare const _default: {
410
429
  typographyMessageHeadingL: string;
411
430
  typographyMessageTextM: string;
412
431
  typographyMessageTextL: string;
432
+ typographyNoteEditorNameM: string;
433
+ typographyNoteDateM: string;
434
+ typographyNoteParagraphM: string;
435
+ typographyNoteParagraphListM: string;
436
+ typographyNoteTitleM: string;
413
437
  typographyPageStateTitleM: string;
414
438
  typographyPageStateSubtitleM: string;
415
439
  typographyPageStateParagraphM: string;
@@ -481,11 +505,6 @@ declare const _default: {
481
505
  typographyTileSubscriptionPriceM: string;
482
506
  typographyTooltipTextM: string;
483
507
  typographyTooltipTextL: string;
484
- typographyNoteEditorNameM: string;
485
- typographyNoteDateM: string;
486
- typographyNoteParagraphM: string;
487
- typographyNoteParagraphListM: string;
488
- typographyNoteTitleM: string;
489
508
  opacity300: string;
490
509
  opacity600: string;
491
510
  opacity800: string;
@@ -52,6 +52,7 @@ declare const _default: {
52
52
  colorsActionMinor500: string;
53
53
  colorsActionMinor550: string;
54
54
  colorsActionMinor600: string;
55
+ colorsActionMinor700: string;
55
56
  colorsActionMinor850: string;
56
57
  colorsActionMinor900: string;
57
58
  colorsActionMinor025: string;
@@ -62,6 +63,7 @@ declare const _default: {
62
63
  colorsActionMinorYin065: string;
63
64
  colorsActionMinorYin090: string;
64
65
  colorsActionMinorYang100: string;
66
+ colorsActionMinorGray700: string;
65
67
  colorsActionDisabled400: string;
66
68
  colorsActionDisabled500: string;
67
69
  colorsActionDisabled600: string;
@@ -81,6 +83,7 @@ declare const _default: {
81
83
  colorsSemanticFocus250: string;
82
84
  colorsSemanticFocus500: string;
83
85
  colorsSemanticFocusTransparent: string;
86
+ colorsSemanticPositive400: string;
84
87
  colorsSemanticPositive500: string;
85
88
  colorsSemanticPositive600: string;
86
89
  colorsSemanticPositiveTransparent: string;
@@ -144,6 +147,8 @@ declare const _default: {
144
147
  colorsReadOnly500: string;
145
148
  colorsReadOnly600: string;
146
149
  colorsComponentsLeftnavWinterStandardBackground: string;
150
+ colorsComponentsLeftnavWinterStandardBackgroundChild: string;
151
+ colorsComponentsLeftnavWinterStandardDividerOnDark: string;
147
152
  colorsComponentsLeftnavWinterStandardHover: string;
148
153
  colorsComponentsLeftnavWinterStandardSelected: string;
149
154
  colorsComponentsLeftnavWinterStandardContent: string;
@@ -237,14 +242,21 @@ declare const _default: {
237
242
  sizing450: string;
238
243
  sizing500: string;
239
244
  sizing525: string;
245
+ sizing550: string;
240
246
  sizing600: string;
241
247
  sizing700: string;
242
248
  sizing800: string;
243
249
  sizing900: string;
244
250
  sizing1000: string;
251
+ sizing1100: string;
245
252
  sizing1200: string;
246
253
  sizing1300: string;
254
+ sizing1500: string;
247
255
  sizing1600: string;
256
+ sizing2000: string;
257
+ sizing2500: string;
258
+ sizing3000: string;
259
+ sizing7000: string;
248
260
  sizing010: string;
249
261
  sizing025: string;
250
262
  sizing050: string;
@@ -268,6 +280,7 @@ declare const _default: {
268
280
  spacing000: string;
269
281
  spacing010: string;
270
282
  spacing025: string;
283
+ spacing035: string;
271
284
  spacing050: string;
272
285
  spacing060: string;
273
286
  spacing075: string;
@@ -275,6 +288,7 @@ declare const _default: {
275
288
  spacingNeg025: string;
276
289
  spacingNeg050: string;
277
290
  spacingNeg075: string;
291
+ spacingNeg100: string;
278
292
  borderWidth100: string;
279
293
  borderWidth200: string;
280
294
  borderWidth300: string;
@@ -403,6 +417,11 @@ declare const _default: {
403
417
  typographyLinkTextFocusS: string;
404
418
  typographyLinkTextFocusM: string;
405
419
  typographyLinkTextFocusL: string;
420
+ typographyLoaderMessageXs: string;
421
+ typographyLoaderMessageS: string;
422
+ typographyLoaderMessageM: string;
423
+ typographyLoaderMessageL: string;
424
+ typographyLoaderMessageXl: string;
406
425
  typographyMenuLabelM: string;
407
426
  typographyMenuLabelL: string;
408
427
  typographyMenuSegmentTitleM: string;
@@ -410,6 +429,11 @@ declare const _default: {
410
429
  typographyMessageHeadingL: string;
411
430
  typographyMessageTextM: string;
412
431
  typographyMessageTextL: string;
432
+ typographyNoteEditorNameM: string;
433
+ typographyNoteDateM: string;
434
+ typographyNoteParagraphM: string;
435
+ typographyNoteParagraphListM: string;
436
+ typographyNoteTitleM: string;
413
437
  typographyPageStateTitleM: string;
414
438
  typographyPageStateSubtitleM: string;
415
439
  typographyPageStateParagraphM: string;
@@ -481,11 +505,6 @@ declare const _default: {
481
505
  typographyTileSubscriptionPriceM: string;
482
506
  typographyTooltipTextM: string;
483
507
  typographyTooltipTextL: string;
484
- typographyNoteEditorNameM: string;
485
- typographyNoteDateM: string;
486
- typographyNoteParagraphM: string;
487
- typographyNoteParagraphListM: string;
488
- typographyNoteTitleM: string;
489
508
  opacity300: string;
490
509
  opacity600: string;
491
510
  opacity800: string;
@@ -12,7 +12,7 @@ declare type StyledHeadingTitleProps = {
12
12
  withMargin?: boolean;
13
13
  };
14
14
  declare const StyledHeadingTitle: import("styled-components").StyledComponent<{
15
- ({ "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;
15
+ ({ "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, "aria-hidden": ariaHidden, ...rest }: import("../typography").TypographyProps): import("react").JSX.Element;
16
16
  displayName: string;
17
17
  }, any, StyledHeadingTitleProps, never>;
18
18
  declare const StyledHeadingPills: import("styled-components").StyledComponent<"span", any, {}, never>;
@@ -4,7 +4,9 @@ export interface PillProps extends StyledPillProps {
4
4
  /** The content to display inside of the pill. */
5
5
  children: string;
6
6
  /** Change the color of a status pill. */
7
- colorVariant?: "neutral" | "negative" | "positive" | "warning";
7
+ colorVariant?: "neutral" | "negative" | "positive" | "warning" | "information" | "neutralWhite";
8
+ /** Sets the colour styling when a status pill is rendered on a dark background. */
9
+ isDarkBackground?: boolean;
8
10
  /** Identifier used for testing purposes, applied to the root element of the component. */
9
11
  "data-element"?: string;
10
12
  /** Identifier used for testing purposes, applied to the root element of the component. */
@@ -22,5 +24,5 @@ export interface PillProps extends StyledPillProps {
22
24
  /** @private @ignore title attribute passed down to underlying element */
23
25
  title?: string;
24
26
  }
25
- export declare const Pill: ({ wrapText, borderColor, colorVariant, children, fill, maxWidth, onClick, onDelete, pillRole, size, ariaLabelOfRemoveButton, ...rest }: PillProps) => React.JSX.Element;
27
+ export declare const Pill: ({ wrapText, borderColor, colorVariant, isDarkBackground, children, fill, maxWidth, onClick, onDelete, pillRole, size, ariaLabelOfRemoveButton, ...rest }: PillProps) => React.JSX.Element;
26
28
  export default Pill;
@@ -12,10 +12,12 @@ var _tags = _interopRequireDefault(require("../../__internal__/utils/helpers/tag
12
12
  var _iconButton = _interopRequireDefault(require("../icon-button"));
13
13
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
14
14
  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); }
15
+ let neutralWhiteWarnTriggered = false;
15
16
  const Pill = ({
16
17
  wrapText,
17
18
  borderColor,
18
19
  colorVariant = "neutral",
20
+ isDarkBackground = false,
19
21
  children,
20
22
  fill = false,
21
23
  maxWidth,
@@ -25,23 +27,31 @@ const Pill = ({
25
27
  size = "M",
26
28
  ariaLabelOfRemoveButton = "remove pill",
27
29
  ...rest
28
- }) => /*#__PURE__*/_react.default.createElement(_pill.default, _extends({
29
- inFill: fill,
30
- colorVariant: colorVariant,
31
- isDeletable: !!onDelete,
32
- pillRole: pillRole,
33
- size: size,
34
- borderColor: borderColor,
35
- onClick: onClick
36
- }, (0, _tags.default)("pill", rest), {
37
- maxWidth: maxWidth,
38
- wrapText: wrapText
39
- }, rest), children, onDelete && /*#__PURE__*/_react.default.createElement(_iconButton.default, {
40
- onClick: onDelete,
41
- "data-element": "close",
42
- "aria-label": ariaLabelOfRemoveButton
43
- }, /*#__PURE__*/_react.default.createElement(_icon.default, {
44
- type: "cross"
45
- })));
30
+ }) => {
31
+ if (!neutralWhiteWarnTriggered && !isDarkBackground && colorVariant === "neutralWhite" && !fill) {
32
+ neutralWhiteWarnTriggered = true;
33
+ // eslint-disable-next-line no-console
34
+ console.warn("[WARNING] The `neutralWhite` variant should only be used on dark backgrounds with fill set to true. " + "Please set the `isDarkBackground` and `fill` props to true or use another color variant.");
35
+ }
36
+ return /*#__PURE__*/_react.default.createElement(_pill.default, _extends({
37
+ inFill: fill,
38
+ colorVariant: colorVariant,
39
+ isDarkBackground: isDarkBackground,
40
+ isDeletable: !!onDelete,
41
+ pillRole: pillRole,
42
+ size: size,
43
+ borderColor: borderColor,
44
+ onClick: onClick
45
+ }, (0, _tags.default)("pill", rest), {
46
+ maxWidth: maxWidth,
47
+ wrapText: wrapText
48
+ }, rest), children, onDelete && /*#__PURE__*/_react.default.createElement(_iconButton.default, {
49
+ onClick: onDelete,
50
+ "data-element": "close",
51
+ "aria-label": ariaLabelOfRemoveButton
52
+ }, /*#__PURE__*/_react.default.createElement(_icon.default, {
53
+ type: "cross"
54
+ })));
55
+ };
46
56
  exports.Pill = Pill;
47
57
  var _default = exports.default = Pill;
@@ -9,10 +9,12 @@ interface StyledPillConfig {
9
9
  negative: StyledPillInnerConfigProps;
10
10
  warning: StyledPillInnerConfigProps;
11
11
  positive: StyledPillInnerConfigProps;
12
+ information: StyledPillInnerConfigProps;
13
+ neutralWhite: StyledPillInnerConfigProps;
12
14
  };
13
15
  tag: {
14
16
  primary: StyledPillInnerConfigProps;
15
17
  };
16
18
  }
17
- declare const _default: () => StyledPillConfig;
19
+ declare const _default: (isDarkBackground: boolean) => StyledPillConfig;
18
20
  export default _default;
@@ -4,18 +4,18 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.default = void 0;
7
- var _default = () => {
7
+ var _default = isDarkBackground => {
8
8
  return {
9
9
  status: {
10
10
  neutral: {
11
- varietyColor: "var(--colorsSemanticNeutral500)",
12
- buttonFocus: "var(--colorsSemanticNeutral600)",
13
- content: "var(--colorsSemanticNeutralYang100)"
11
+ varietyColor: isDarkBackground ? "var(--colorsSemanticNeutral400)" : "var(--colorsSemanticNeutral500)",
12
+ buttonFocus: isDarkBackground ? "var(--colorsSemanticNeutral500)" : "var(--colorsSemanticNeutral600)",
13
+ content: isDarkBackground ? "var(--colorsSemanticNeutralYin090)" : "var(--colorsSemanticNeutralYang100)"
14
14
  },
15
15
  negative: {
16
- varietyColor: "var(--colorsSemanticNegative500)",
17
- buttonFocus: "var(--colorsSemanticNegative600)",
18
- content: "var(--colorsSemanticNegativeYang100)"
16
+ varietyColor: isDarkBackground ? "var(--colorsSemanticNegative450)" : "var(--colorsSemanticNegative500)",
17
+ buttonFocus: isDarkBackground ? "var(--colorsSemanticNegative500)" : "var(--colorsSemanticNegative600)",
18
+ content: isDarkBackground ? "var(--colorsSemanticNegativeYin090)" : "var(--colorsSemanticNegativeYang100)"
19
19
  },
20
20
  warning: {
21
21
  varietyColor: "var(--colorsSemanticCaution400)",
@@ -23,9 +23,19 @@ var _default = () => {
23
23
  content: "var(--colorsSemanticCautionYin090)"
24
24
  },
25
25
  positive: {
26
- varietyColor: "var(--colorsSemanticPositive500)",
27
- buttonFocus: "var(--colorsSemanticPositive600)",
28
- content: "var(--colorsSemanticPositiveYang100)"
26
+ varietyColor: isDarkBackground ? "var(--colorsSemanticPositive400)" : "var(--colorsSemanticPositive500)",
27
+ buttonFocus: isDarkBackground ? "var(--colorsSemanticPositive500)" : "var(--colorsSemanticPositive600)",
28
+ content: isDarkBackground ? "var(--colorsSemanticPositiveYin090)" : "var(--colorsSemanticPositiveYang100)"
29
+ },
30
+ information: {
31
+ varietyColor: isDarkBackground ? "var(--colorsSemanticInfo400)" : "var(--colorsSemanticInfo500)",
32
+ buttonFocus: isDarkBackground ? "var(--colorsSemanticInfo500)" : "var(--colorsSemanticInfo600)",
33
+ content: isDarkBackground ? "var(--colorsSemanticInfoYin090)" : "var(--colorsSemanticInfoYang100)"
34
+ },
35
+ neutralWhite: {
36
+ varietyColor: "var(--colorsSemanticNeutralYang100)",
37
+ buttonFocus: "var(--colorsSemanticNeutralYin030)",
38
+ content: "var(--colorsSemanticNeutral500)"
29
39
  }
30
40
  },
31
41
  tag: {
@@ -15,7 +15,8 @@ export interface StyledPillProps extends MarginProps {
15
15
  interface AllStyledPillProps extends StyledPillProps {
16
16
  inFill?: boolean;
17
17
  isDeletable: boolean;
18
- colorVariant: "neutral" | "negative" | "positive" | "warning";
18
+ isDarkBackground: boolean;
19
+ colorVariant: "neutral" | "negative" | "positive" | "warning" | "information" | "neutralWhite";
19
20
  pillRole: "tag" | "status";
20
21
  }
21
22
  declare const StyledPill: import("styled-components").StyledComponent<"span", any, AllStyledPillProps, never>;
@@ -30,6 +30,7 @@ const StyledPill = _styledComponents.default.span`
30
30
  wrapText,
31
31
  borderColor,
32
32
  colorVariant,
33
+ isDarkBackground,
33
34
  isDeletable,
34
35
  inFill,
35
36
  maxWidth,
@@ -50,7 +51,7 @@ const StyledPill = _styledComponents.default.span`
50
51
  const {
51
52
  status,
52
53
  tag
53
- } = (0, _pillStyle.default)();
54
+ } = (0, _pillStyle.default)(isDarkBackground);
54
55
  const {
55
56
  varietyColor,
56
57
  buttonFocus,
@@ -92,7 +93,7 @@ const StyledPill = _styledComponents.default.span`
92
93
  `}
93
94
 
94
95
  ${!inFill && (0, _styledComponents.css)`
95
- color: var(--colorsUtilityYin090);
96
+ color: ${!isDarkBackground ? "var(--colorsUtilityYin090)" : "var(--colorsUtilityYang100)"};
96
97
  `}
97
98
 
98
99
  ${size === "S" && (0, _styledComponents.css)`
@@ -213,7 +214,7 @@ const StyledPill = _styledComponents.default.span`
213
214
 
214
215
  ${!inFill && (0, _styledComponents.css)`
215
216
  ${_icon.default} {
216
- color: var(--colorsUtilityYin090);
217
+ color: ${!isDarkBackground ? "var(--colorsUtilityYin090)" : "var(--colorsUtilityYang100)"};
217
218
  }
218
219
  `}
219
220
  }
@@ -0,0 +1,2 @@
1
+ export { default as StepFlow } from "./step-flow.component";
2
+ export type { StepFlowProps } from "./step-flow.component";
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ Object.defineProperty(exports, "StepFlow", {
7
+ enumerable: true,
8
+ get: function () {
9
+ return _stepFlow.default;
10
+ }
11
+ });
12
+ var _stepFlow = _interopRequireDefault(require("./step-flow.component"));
13
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -0,0 +1,6 @@
1
+ {
2
+ "sideEffects": false,
3
+ "module": "../../../esm/components/step-flow/index.js",
4
+ "main": "./index.js",
5
+ "types": "./index.d.ts"
6
+ }
@@ -0,0 +1,33 @@
1
+ import React from "react";
2
+ import { MarginProps } from "styled-system";
3
+ import { TagProps } from "../../__internal__/utils/helpers/tags/tags";
4
+ export declare type Steps = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
5
+ export interface StepFlowProps extends MarginProps, TagProps {
6
+ /** A category for the user journey. */
7
+ category?: string;
8
+ /** The title of the current step. */
9
+ title: string;
10
+ /** Set the variant of the internal 'Typography' component which contains the title.
11
+ * However, despite the chosen variant the styling will always be overridden.
12
+ */
13
+ titleVariant?: "h1" | "h2";
14
+ /** The total steps in the user journey. */
15
+ totalSteps: Steps;
16
+ /**
17
+ * The current step of the user journey. If the set `currentStep` is higher than
18
+ * `totalSteps`the value of `currentStep` will be that of `totalSteps` instead.
19
+ */
20
+ currentStep: Steps;
21
+ /** Determines if the progress indicator is shown. */
22
+ showProgressIndicator?: boolean;
23
+ /** Determines if the close icon button is shown */
24
+ showCloseIcon?: boolean;
25
+ /** function runs when user click dismiss button */
26
+ onDismiss?: (e: React.KeyboardEvent<HTMLButtonElement> | React.MouseEvent<HTMLButtonElement>) => void;
27
+ }
28
+ export declare type StepFlowHandle = {
29
+ /** Programmatically focus on root container of Dialog. */
30
+ focus: () => void;
31
+ } | null;
32
+ export declare const StepFlow: React.ForwardRefExoticComponent<StepFlowProps & React.RefAttributes<StepFlowHandle>>;
33
+ export default StepFlow;