Skip to content

Commit c031dd7

Browse files
committed
Add ReportsSplitNavigator docs and adjust comment in ActiveWorkspaceProvider
1 parent 0200ec4 commit c031dd7

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

src/components/ActiveWorkspaceProvider/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ function ActiveWorkspaceContextProvider({children}: ChildrenProps) {
1818
() => ({
1919
activeWorkspaceID,
2020

21-
// We are exporting setActiveWorkspace to speedup updating this value after changing activeWorkspaceID to avoid flickering of workspace avatar.
21+
// We are exporting setActiveWorkspace to speed up updating this value after changing activeWorkspaceID to avoid flickering of workspace avatar.
2222
setActiveWorkspaceID,
2323
}),
2424
[activeWorkspaceID],

src/libs/Navigation/AppNavigator/Navigators/ReportsSplitNavigator.tsx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ const loadSidebarScreen = () => require<ReactComponentModule>('@pages/home/sideb
1919

2020
const Split = createSplitNavigator<ReportsSplitNavigatorParamList>();
2121

22+
/**
23+
* This SplitNavigator includes the HOME screen (<BaseSidebarScreen /> component) with a list of reports as a sidebar screen and the REPORT screen displayed as a central one.
24+
* There can be multiple report screens in the stack with different report IDs.
25+
*/
2226
function ReportsSplitNavigator({route}: PlatformStackScreenProps<AuthScreensParamList, typeof NAVIGATORS.REPORTS_SPLIT_NAVIGATOR>) {
2327
const {canUseDefaultRooms} = usePermissions();
2428
const {activeWorkspaceID} = useActiveWorkspace();

0 commit comments

Comments
 (0)