Merge branch 'main' into twisterdotcom-patch-3

Author: twisterdotcom

contributingGuides/NAVIGATION.md

@@ -96,7 +96,7 @@ function AnchorRenderer({tnode, style, key}: AnchorRendererProps) {
             linkStyle = [
                 styles.link,
                 {
-                    fontSize: styles.formError.fontSize,
+                    fontSize: styles.textMicro.fontSize,
                     textDecorationLine: 'underline',
                 },
             ];

src/components/HTMLEngineProvider/HTMLRenderers/AnchorRenderer.tsx

@@ -24,6 +24,19 @@ function getRoutePolicyID(route: NavigationPartialRoute): string | undefined {
     return (route?.params as Record<string, string> | undefined)?.policyID;
 }
 
+/**
+ * Adapts the navigation state of a SplitNavigator to ensure proper screen layout and navigation flow.
+ * This function handles both narrow and wide layouts, ensuring that:
+ * 1. On narrow layout, it manages sidebar visibility appropriately
+ * 2. On wide layout, it ensures both sidebar and central screens are present
+ * 3. Handles policy-specific navigation states
+ *
+ * For detailed information about SplitNavigator state adaptation and navigation patterns,
+ * see the NAVIGATION.md documentation.
+ *
+ * @param state - The current navigation state to adapt
+ * @param options - Configuration options including sidebarScreen, defaultCentralScreen, and parentRoute
+ */
 function adaptStateIfNecessary({state, options: {sidebarScreen, defaultCentralScreen, parentRoute}}: AdaptStateIfNecessaryArgs) {
     const isNarrowLayout = getIsNarrowLayout();
     const rootState = navigationRef.getRootState();

src/libs/Navigation/AppNavigator/createSplitNavigator/SplitRouter.ts

@@ -180,6 +180,8 @@ function isActiveRoute(routePath: Route): boolean {
 /**
  * Navigates to a specified route.
  * Main navigation method for redirecting to a route.
+ * For detailed information about moving between screens,
+ * see the NAVIGATION.md documentation.
  *
  * @param route - The route to navigate to.
  * @param options - Optional navigation options.
@@ -326,6 +328,9 @@ function goUp(backToRoute: Route, options?: GoBackOptions) {
 }
 
 /**
+ * Navigate back to the previous screen or a specified route.
+ * For detailed information about navigation patterns and best practices,
+ * see the NAVIGATION.md documentation.
  * @param backToRoute - Fallback route if pop/goBack action should, but is not possible within RHP
  * @param options - Optional configuration that affects navigation logic
  */
@@ -347,6 +352,11 @@ function goBack(backToRoute?: Route, options?: GoBackOptions) {
     navigationRef.current?.goBack();
 }
 
+/**
+ * Navigate back to the sidebar screen in SplitNavigator and pop all central screens from the navigator at the same time.
+ * For detailed information about moving between screens,
+ * see the NAVIGATION.md documentation.
+ */
 function popToSidebar() {
     setShouldPopToSidebar(false);
 
@@ -537,6 +547,8 @@ function getReportRouteByID(reportID?: string, routes: NavigationRoute[] = navig
 
 /**
  * Closes the modal navigator (RHP, onboarding).
+ * For detailed information about dismissing modals,
+ * see the NAVIGATION.md documentation.
  */
 const dismissModal = (ref = navigationRef) => {
     isNavigationReady().then(() => {
@@ -546,6 +558,8 @@ const dismissModal = (ref = navigationRef) => {
 
 /**
  * Dismisses the modal and opens the given report.
+ * For detailed information about dismissing modals,
+ * see the NAVIGATION.md documentation.
  */
 const dismissModalWithReport = (
     {reportID, reportActionID, referrer, moneyRequestReportActionID, transactionID, backTo}: ReportsSplitNavigatorParamList[typeof SCREENS.REPORT],

src/libs/Navigation/Navigation.ts

@@ -210,6 +210,18 @@ function getAdaptedState(state: PartialState<NavigationState<RootNavigatorParamL
     return state;
 }
 
+/**
+ * Generate a navigation state from a given path, adapting it to handle cases like onboarding flow,
+ * displaying RHP screens and navigating in the Workspaces tab.
+ * For detailed information about generating state from a path,
+ * see the NAVIGATION.md documentation.
+ *
+ * @param path - The path to generate state from
+ * @param options - Extra options to fine-tune how to parse the path
+ * @param shouldReplacePathInNestedState - Whether to replace the path in nested state
+ * @returns The adapted navigation state
+ * @throws Error if unable to get state from path
+ */
 const getAdaptedStateFromPath: GetAdaptedStateFromPath = (path, options, shouldReplacePathInNestedState = true) => {
     const normalizedPath = !path.startsWith('/') ? `/${path}` : path;
 

src/libs/Navigation/helpers/getAdaptedStateFromPath.ts

@@ -5,6 +5,14 @@ import SIDEBAR_TO_RHP from './SIDEBAR_TO_RHP';
 import SIDEBAR_TO_SPLIT from './SIDEBAR_TO_SPLIT';
 import WORKSPACE_TO_RHP from './WORKSPACE_TO_RHP';
 
+/**
+ * This module manages the relationships between different fullscreen navigators and screens in the app.
+ * It defines how screens in fullscreen navigator relate to screens in another navigator, particularly
+ * for handling RHP (Right Hand Panel) navigation.
+ *
+ * For detailed information about setting the correct screen underneath RHP,
+ * see the NAVIGATION.md documentation.
+ */
 function createInverseRelation<T extends string, K extends string>(relations: Partial<Record<T, K | K[]>>): Record<K, T> {
     const reversedRelations = {} as Record<K, T>;