rename form state into flow state

Author: charlotteisambert

packages/example/src/FlowNavigatorExample.tsx

@@ -35,12 +35,12 @@ export const FlowNavigatorExample = () => {
     );
   }
 
-  const initialFormState = {
+  const initialFlowState = {
     myValue31: false,
     myValue4: hasToPassStep4,
   };
 
-  type FlowState = typeof initialFormState;
+  type FlowState = typeof initialFlowState;
 
   const config = {
     Step31: (flowState: FlowState) => flowState.myValue31,
@@ -51,7 +51,7 @@ export const FlowNavigatorExample = () => {
     <FlowNavigator.Navigator
       screenOptions={{headerShown: false}}
       config={config}
-      initialFormState={initialFormState}>
+      initialFlowState={initialFlowState}>
       <FlowNavigator.Screen name="Step1" component={Step1Page} />
       <FlowNavigator.Screen name="Step2" component={Step2Navigator} />
       <FlowNavigator.Group>

packages/lib/src/navigators/createFlowNavigator.tsx

@@ -30,7 +30,7 @@ function FlowNavigator({
   screenListeners,
   screenOptions,
   config,
-  initialFormState,
+  initialFlowState,
   ...rest
 }: FlowNavigatorProps) {
   const parentNavigation = useNavigation();
@@ -46,7 +46,7 @@ function FlowNavigator({
       FlowActionHelpers<ParamListBase>,
       FlowNavigationOptions,
       FlowNavigationEventMap
-    >(buildFlowRouter(quitFlow, { config, initialFormState }), {
+    >(buildFlowRouter(quitFlow, { config, initialFlowState }), {
       id,
       initialRouteName,
       children,

packages/lib/src/routers/FlowRouter.ts

@@ -43,8 +43,8 @@ export const buildFlowRouter =
     quitFlowHelper: () => void,
     {
       config,
-      initialFormState,
-    }: { config: Config<ParamListBase>; initialFormState: FlowState }
+      initialFlowState,
+    }: { config: Config<ParamListBase>; initialFlowState: FlowState }
   ) =>
   (
     options: FlowRouterOptions
@@ -65,7 +65,7 @@ export const buildFlowRouter =
 
         const disabledRouteNames = Object.entries(config)
           .filter(([_, isRouteNameEnabledCb]) => {
-            return !isRouteNameEnabledCb(initialFormState);
+            return !isRouteNameEnabledCb(initialFlowState);
           })
           .map(([routeName]) => routeName);
 
@@ -130,14 +130,14 @@ export const buildFlowRouter =
             return state;
 
           case "SET_STORE_STATE":
-            const newFormState = {
+            const newFlowState = {
               ...state.flowState,
               ...action.payload.flowState,
             };
 
             const disabledRouteNames = Object.entries(config)
               .filter(([_, isRouteNameEnabledCb]) => {
-                return !isRouteNameEnabledCb(newFormState);
+                return !isRouteNameEnabledCb(newFlowState);
               })
               .map(([routeName]) => routeName);
 

packages/lib/src/types/types.ts

@@ -63,7 +63,7 @@ export type FlowNavigatorProps = DefaultNavigatorOptions<
   StackRouterOptions &
   NativeStackNavigationConfig & {
     config: Config<ParamListBase>;
-    initialFormState: FlowState;
+    initialFlowState: FlowState;
   };
 
 export type FlowStackNavigationOptions = NativeStackNavigationOptions & {