@carbon/utilities-react 0.13.0 → 0.14.0

package/es/StepFlow/StepContext.js

@@ -0,0 +1 @@
+import{jsx as x}from"react/jsx-runtime";import{useContext as a,createContext as u,useState as r}from"react";const n=u(void 0),h=({children:t})=>{const[p,d]=r(1),[s,o]=r(1),[S,c]=r({}),i={formState:S,setFormState:c,totalSteps:p,setTotalSteps:d,currentStep:s,handleGoToStep:e=>o(e),handleNext:()=>o(e=>e+1),handlePrevious:()=>o(e=>e-1)};return x(n.Provider,{value:i,children:t})},m=()=>{const t=a(n);if(t===void 0)throw new Error("Context hook used outside of Step provider");return t};export{h as StepProvider,m as useStepContext};

package/es/StepFlow/StepGroup.js

@@ -0,0 +1 @@
+import n,{useEffect as p}from"react";import{useStepContext as c}from".";const a=({children:r})=>{const{setTotalSteps:e,currentStep:o}=c(),t=n.Children.toArray(r);return p(()=>{e(t.length)},[t.length,e]),t[o-1]};export{a as StepGroup};

package/es/StepFlow/index.js

@@ -0,0 +1 @@
+import{StepGroup as p}from"./StepGroup";import{StepProvider as r,useStepContext as x}from"./StepContext";export{p as StepGroup,r as StepProvider,x as useStepContext};

package/es/index.js

@@ -1 +1 @@
-export*from"@carbon/utilities";export*from"./useNoInteractiveChildren";
+export*from"@carbon/utilities";export*from"./useNoInteractiveChildren";export*from"./StepFlow";

package/lib/StepFlow/StepContext.js

@@ -0,0 +1 @@
+"use strict";var s=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var C=Object.getOwnPropertyNames;var f=Object.prototype.hasOwnProperty;var v=(e,t)=>{for(var n in t)s(e,n,{get:t[n],enumerable:!0})},P=(e,t,n,d)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of C(t))!f.call(e,o)&&o!==n&&s(e,o,{get:()=>t[o],enumerable:!(d=x(t,o))||d.enumerable});return e};var l=e=>P(s({},"__esModule",{value:!0}),e);var T={};v(T,{StepProvider:()=>h,useStepContext:()=>m});module.exports=l(T);var c=require("react/jsx-runtime"),r=require("react");const S=(0,r.createContext)(void 0),h=({children:e})=>{const[t,n]=(0,r.useState)(1),[d,o]=(0,r.useState)(1),[i,a]=(0,r.useState)({}),u={formState:i,setFormState:a,totalSteps:t,setTotalSteps:n,currentStep:d,handleGoToStep:p=>o(p),handleNext:()=>o(p=>p+1),handlePrevious:()=>o(p=>p-1)};return(0,c.jsx)(S.Provider,{value:u,children:e})},m=()=>{const e=(0,r.useContext)(S);if(e===void 0)throw new Error("Context hook used outside of Step provider");return e};

package/lib/StepFlow/StepGroup.js

@@ -0,0 +1 @@
+"use strict";var S=Object.create;var p=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var i=Object.getOwnPropertyNames;var l=Object.getPrototypeOf,m=Object.prototype.hasOwnProperty;var f=(t,e)=>{for(var r in e)p(t,r,{get:e[r],enumerable:!0})},s=(t,e,r,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of i(e))!m.call(t,n)&&n!==r&&p(t,n,{get:()=>e[n],enumerable:!(o=a(e,n))||o.enumerable});return t};var h=(t,e,r)=>(r=t!=null?S(l(t)):{},s(e||!t||!t.__esModule?p(r,"default",{value:t,enumerable:!0}):r,t)),d=t=>s(p({},"__esModule",{value:!0}),t);var G={};f(G,{StepGroup:()=>C});module.exports=d(G);var c=h(require("react")),u=require(".");const C=({children:t})=>{const{setTotalSteps:e,currentStep:r}=(0,u.useStepContext)(),o=c.default.Children.toArray(t);return(0,c.useEffect)(()=>{e(o.length)},[o.length,e]),o[r-1]};

package/lib/StepFlow/index.js

@@ -0,0 +1 @@
+"use strict";var x=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var n=Object.prototype.hasOwnProperty;var s=(t,e)=>{for(var o in e)x(t,o,{get:e[o],enumerable:!0})},u=(t,e,o,S)=>{if(e&&typeof e=="object"||typeof e=="function")for(let p of y(e))!n.call(t,p)&&p!==o&&x(t,p,{get:()=>e[p],enumerable:!(S=m(e,p))||S.enumerable});return t};var C=t=>u(x({},"__esModule",{value:!0}),t);var d={};s(d,{StepGroup:()=>f.StepGroup,StepProvider:()=>r.StepProvider,useStepContext:()=>r.useStepContext});module.exports=C(d);var f=require("./StepGroup"),r=require("./StepContext");

package/lib/StepFlow/types.js

@@ -0,0 +1 @@
+"use strict";var n=Object.defineProperty;var S=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var i=Object.prototype.hasOwnProperty;var m=(e,t,r,a)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of p(t))!i.call(e,o)&&o!==r&&n(e,o,{get:()=>t[o],enumerable:!(a=S(t,o))||a.enumerable});return e};var s=e=>m(n({},"__esModule",{value:!0}),e);var c={};module.exports=s(c);

package/lib/index.js

@@ -1 +1 @@
-"use strict";var a=Object.defineProperty;var b=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var d=Object.prototype.hasOwnProperty;var t=(r,o,p,x)=>{if(o&&typeof o=="object"||typeof o=="function")for(let m of c(o))!d.call(r,m)&&m!==p&&a(r,m,{get:()=>o[m],enumerable:!(x=b(o,m))||x.enumerable});return r},f=(r,o,p)=>(t(r,o,"default"),p&&t(p,o,"default"));var g=r=>t(a({},"__esModule",{value:!0}),r);var e={};module.exports=g(e);f(e,require("@carbon/utilities"),module.exports);f(e,require("./useNoInteractiveChildren"),module.exports);
+"use strict";var a=Object.defineProperty;var b=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var d=Object.prototype.hasOwnProperty;var t=(f,r,p,x)=>{if(r&&typeof r=="object"||typeof r=="function")for(let m of c(r))!d.call(f,m)&&m!==p&&a(f,m,{get:()=>r[m],enumerable:!(x=b(r,m))||x.enumerable});return f},e=(f,r,p)=>(t(f,r,"default"),p&&t(p,r,"default"));var g=f=>t(a({},"__esModule",{value:!0}),f);var o={};module.exports=g(o);e(o,require("@carbon/utilities"),module.exports);e(o,require("./useNoInteractiveChildren"),module.exports);e(o,require("./StepFlow"),module.exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/utilities-react",
   "description": "Utilities and helpers to drive consistency across software products using the Carbon Design System with React",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -45,11 +45,11 @@
     "esbuild": "^0.25.0",
     "rimraf": "^6.0.1",
     "typescript": "^5.7.3",
-    "typescript-config-carbon": "^0.7.0"
+    "typescript-config-carbon": "^0.8.0"
   },
   "dependencies": {
-    "@carbon/utilities": "^0.10.0",
+    "@carbon/utilities": "^0.11.0",
     "@ibm/telemetry-js": "^1.6.1"
   },
-  "gitHead": "c76188a59aad432ce28e79b1a8a6b95457ba2cce"
+  "gitHead": "c17cce753e36124e6e8e02daba97ae9d4decbcc3"
 }

package/types/StepFlow/StepContext.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { ReactNode } from 'react';
+import { StepContextType } from './types';
+interface StepProviderProps {
+    children: ReactNode;
+}
+export declare const StepProvider: ({ children }: StepProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useStepContext: () => StepContextType;
+export {};

package/types/StepFlow/StepGroup.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+interface StepGroupProps {
+    children: React.ReactNode;
+}
+/**
+ * Container for steps. The children are filtered for only truthy values (via Children.toArray)
+ * and only the current step is returned from this component based on the `currentStep` value
+ * from `useStepContext`.
+ */
+export declare const StepGroup: ({ children }: StepGroupProps) => string | number | bigint | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined>;
+export {};

package/types/StepFlow/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { StepGroup } from './StepGroup';
+export { StepProvider, useStepContext } from './StepContext';
+export type { StepContextType } from './types';

package/types/StepFlow/types.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { Dispatch, SetStateAction } from 'react';
+/**
+ * This interface should be extended by the consumer to match their own unique
+ * use case given the fields within their own stepped experience.
+ */
+interface formStateType {
+    [key: string]: unknown;
+}
+export interface StepContextType {
+    formState: formStateType;
+    setFormState: Dispatch<SetStateAction<formStateType>>;
+    totalSteps: number;
+    setTotalSteps: Dispatch<SetStateAction<number>>;
+    currentStep: number;
+    handleGoToStep: (step: number) => void;
+    handleNext: () => void;
+    handlePrevious: () => void;
+}
+export {};

package/types/index.d.ts

@@ -6,3 +6,4 @@
  */
 export * from '@carbon/utilities';
 export * from './useNoInteractiveChildren';
+export * from './StepFlow';