Add documentation comment to theme background color field

Expensify · Sep 18, 2023 · fcc4258 · fcc4258
1 parent b798240
commit fcc4258
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/styles/themes/default.js b/src/styles/themes/default.js
@@ -83,6 +83,10 @@ const darkTheme = {
     starDefaultBG: 'rgb(254, 228, 94)',
 };
 
+// Adding a color here will animate the status bar to the right color when the screen is opened.
+// Note that it needs to be a screen name, not a route url.
+// The route urls from ROUTES.ts are only used for deep linking and configuring URLs on web.
+// The screen name (see SCREENS.ts) is the name of the screen as far as react-navigation is concerned, and the linkingConfig maps screen names to URLs
 darkTheme.PAGE_BACKGROUND_COLORS = {
     [SCREENS.HOME]: darkTheme.sidebar,
     [SCREENS.SAVE_THE_WORLD.ROOT]: colors.tangerine800,

diff --git a/src/styles/themes/light.js b/src/styles/themes/light.js
@@ -82,6 +82,10 @@ const lightTheme = {
     starDefaultBG: 'rgb(254, 228, 94)',
 };
 
+// Adding a color here will animate the status bar to the right color when the screen is opened.
+// Note that it needs to be a screen name, not a route url.
+// The route urls from ROUTES.ts are only used for deep linking and configuring URLs on web.
+// The screen name (see SCREENS.ts) is the name of the screen as far as react-navigation is concerned, and the linkingConfig maps screen names to URLs
 lightTheme.PAGE_BACKGROUND_COLORS = {
     [SCREENS.HOME]: lightTheme.sidebar,
     [SCREENS.SAVE_THE_WORLD.ROOT]: colors.tangerine800,