-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement <ScrollRestoration /> #5086
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
66e5a95
Implement <ScrollRestoration />
gitstart-twenty 33b1b7f
use createBrowserProvider
gitstart-twenty 931cf4d
Merge commit '6e8c6c8e582dda0203fe35c36dff6bd3cd009231' into TWNTY-4357
gitstart-twenty 8594b0f
Merge main
gitstart-twenty aa2c281
Merge branch 'main' into TWNTY-4357
lucasbordeau cc70e8b
Put CaptchaProvider back
lucasbordeau 48b93bf
Merge commit '6898c1e4d8133e5321509d7d5cedcc28f190ed2f' of https://gi…
gitstart-twenty a46ee63
Implement scroll restoration
gitstart-twenty 09a95c6
Merge commit 'ea5a7ba70ea3de2454c086c7f0cbf9f57e281fde' of https://gi…
gitstart-twenty fbdd2ad
Refactor according to comments
gitstart-twenty 8f34323
Merge commit '992602b307d4bbc188619673930780ee2b4a1def' of https://gi…
gitstart-twenty 456b4b3
Refactor according to review
gitstart-twenty File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,39 @@ | ||
import { Route, Routes, useLocation } from 'react-router-dom'; | ||
import { StrictMode } from 'react'; | ||
import { | ||
createBrowserRouter, | ||
createRoutesFromElements, | ||
Outlet, | ||
redirect, | ||
Route, | ||
RouterProvider, | ||
Routes, | ||
useLocation, | ||
} from 'react-router-dom'; | ||
import { useRecoilValue } from 'recoil'; | ||
|
||
import { ApolloProvider } from '@/apollo/components/ApolloProvider'; | ||
import { VerifyEffect } from '@/auth/components/VerifyEffect'; | ||
import { ClientConfigProvider } from '@/client-config/components/ClientConfigProvider'; | ||
import { ClientConfigProviderEffect } from '@/client-config/components/ClientConfigProviderEffect'; | ||
import { billingState } from '@/client-config/states/billingState'; | ||
import { PromiseRejectionEffect } from '@/error-handler/components/PromiseRejectionEffect'; | ||
import { ApolloMetadataClientProvider } from '@/object-metadata/components/ApolloMetadataClientProvider'; | ||
import { ObjectMetadataItemsProvider } from '@/object-metadata/components/ObjectMetadataItemsProvider'; | ||
import { PrefetchDataProvider } from '@/prefetch/components/PrefetchDataProvider'; | ||
import { AppPath } from '@/types/AppPath'; | ||
import { SettingsPath } from '@/types/SettingsPath'; | ||
import { DialogManager } from '@/ui/feedback/dialog-manager/components/DialogManager'; | ||
import { DialogManagerScope } from '@/ui/feedback/dialog-manager/scopes/DialogManagerScope'; | ||
import { SnackBarProvider } from '@/ui/feedback/snack-bar-manager/components/SnackBarProvider'; | ||
import { BlankLayout } from '@/ui/layout/page/BlankLayout'; | ||
import { DefaultLayout } from '@/ui/layout/page/DefaultLayout'; | ||
import { AppThemeProvider } from '@/ui/theme/components/AppThemeProvider'; | ||
import { PageTitle } from '@/ui/utilities/page-title/PageTitle'; | ||
import { UserProvider } from '@/users/components/UserProvider'; | ||
import { UserProviderEffect } from '@/users/components/UserProviderEffect'; | ||
import { CommandMenuEffect } from '~/effect-components/CommandMenuEffect'; | ||
import { GotoHotkeysEffect } from '~/effect-components/GotoHotkeysEffect'; | ||
import { PageChangeEffect } from '~/effect-components/PageChangeEffect'; | ||
import { Authorize } from '~/pages/auth/Authorize'; | ||
import { ChooseYourPlan } from '~/pages/auth/ChooseYourPlan'; | ||
import { CreateProfile } from '~/pages/auth/CreateProfile'; | ||
|
@@ -54,17 +78,53 @@ import { SettingsWorkspaceMembers } from '~/pages/settings/SettingsWorkspaceMemb | |
import { Tasks } from '~/pages/tasks/Tasks'; | ||
import { getPageTitleFromPath } from '~/utils/title-utils'; | ||
|
||
export const App = () => { | ||
const billing = useRecoilValue(billingState); | ||
const ProvidersThatNeedRouterContext = () => { | ||
const { pathname } = useLocation(); | ||
const pageTitle = getPageTitleFromPath(pathname); | ||
|
||
Comment on lines
82
to
83
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Needs |
||
return ( | ||
<> | ||
<PageTitle title={pageTitle} /> | ||
<GotoHotkeysEffect /> | ||
<CommandMenuEffect /> | ||
<Routes> | ||
<ApolloProvider> | ||
<ClientConfigProviderEffect /> | ||
<ClientConfigProvider> | ||
<UserProviderEffect /> | ||
<UserProvider> | ||
<ApolloMetadataClientProvider> | ||
<ObjectMetadataItemsProvider> | ||
<PrefetchDataProvider> | ||
<AppThemeProvider> | ||
<SnackBarProvider> | ||
<DialogManagerScope dialogManagerScopeId="dialog-manager"> | ||
<DialogManager> | ||
<StrictMode> | ||
<PromiseRejectionEffect /> | ||
<CommandMenuEffect /> | ||
<GotoHotkeysEffect /> | ||
<PageTitle title={pageTitle} /> | ||
<Outlet /> | ||
</StrictMode> | ||
</DialogManager> | ||
</DialogManagerScope> | ||
</SnackBarProvider> | ||
</AppThemeProvider> | ||
</PrefetchDataProvider> | ||
<PageChangeEffect /> | ||
</ObjectMetadataItemsProvider> | ||
</ApolloMetadataClientProvider> | ||
</UserProvider> | ||
</ClientConfigProvider> | ||
</ApolloProvider> | ||
); | ||
}; | ||
|
||
const createRouter = (isBillingEnabled?: boolean) => | ||
createBrowserRouter( | ||
createRoutesFromElements( | ||
<Route | ||
element={<ProvidersThatNeedRouterContext />} | ||
// To switch state to `loading` temporarily to enable us | ||
// to set scroll position before the page is rendered | ||
loader={async () => Promise.resolve(null)} | ||
> | ||
<Route element={<DefaultLayout />}> | ||
<Route path={AppPath.Verify} element={<VerifyEffect />} /> | ||
<Route path={AppPath.SignInUp} element={<SignInUp />} /> | ||
|
@@ -119,12 +179,14 @@ export const App = () => { | |
path={SettingsPath.AccountsEmailsInboxSettings} | ||
element={<SettingsAccountsEmailsInboxSettings />} | ||
/> | ||
{billing?.isBillingEnabled && ( | ||
<Route | ||
path={SettingsPath.Billing} | ||
element={<SettingsBilling />} | ||
/> | ||
)} | ||
<Route | ||
path={SettingsPath.Billing} | ||
element={<SettingsBilling />} | ||
loader={() => { | ||
if (!isBillingEnabled) return redirect(AppPath.Index); | ||
return null; | ||
}} | ||
/> | ||
<Route | ||
path={SettingsPath.WorkspaceMembersPage} | ||
element={<SettingsWorkspaceMembers />} | ||
|
@@ -217,7 +279,12 @@ export const App = () => { | |
<Route element={<BlankLayout />}> | ||
<Route path={AppPath.Authorize} element={<Authorize />} /> | ||
</Route> | ||
</Routes> | ||
</> | ||
</Route>, | ||
), | ||
); | ||
|
||
export const App = () => { | ||
const billing = useRecoilValue(billingState); | ||
|
||
return <RouterProvider router={createRouter(billing?.isBillingEnabled)} />; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
import { useEffect } from 'react'; | ||
import { useLocation, useNavigation } from 'react-router-dom'; | ||
import { useRecoilState, useRecoilValue } from 'recoil'; | ||
|
||
import { overlayScrollbarsState } from '@/ui/utilities/scroll/states/overlayScrollbarsState'; | ||
import { scrollPositionState } from '@/ui/utilities/scroll/states/scrollPositionState'; | ||
import { isDefined } from '~/utils/isDefined'; | ||
|
||
/** | ||
* Note that `location.key` is used in the cache key, not `location.pathname`, | ||
* so the same path navigated to at different points in the history stack will | ||
* not share the same scroll position. | ||
*/ | ||
export const useScrollRestoration = (viewportHeight?: number) => { | ||
const key = `scroll-position-${useLocation().key}`; | ||
const { state } = useNavigation(); | ||
|
||
const [scrollPosition, setScrollPosition] = useRecoilState( | ||
scrollPositionState(key), | ||
); | ||
|
||
const overlayScrollbars = useRecoilValue(overlayScrollbarsState); | ||
|
||
const scrollWrapper = overlayScrollbars?.elements().viewport; | ||
const skip = isDefined(viewportHeight) && scrollPosition > viewportHeight; | ||
|
||
useEffect(() => { | ||
if (state === 'loading') { | ||
setScrollPosition(scrollWrapper?.scrollTop ?? 0); | ||
} else if (state === 'idle' && isDefined(scrollWrapper) && !skip) { | ||
scrollWrapper.scrollTo({ top: scrollPosition }); | ||
} | ||
}, [key, state, scrollWrapper, skip, scrollPosition, setScrollPosition]); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
packages/twenty-front/src/modules/ui/utilities/scroll/states/overlayScrollbarsState.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { OverlayScrollbars } from 'overlayscrollbars'; | ||
import { createState } from 'twenty-ui'; | ||
|
||
export const overlayScrollbarsState = createState<OverlayScrollbars | null>({ | ||
key: 'scroll/overlayScrollbarsState', | ||
defaultValue: null, | ||
}); |
6 changes: 6 additions & 0 deletions
6
packages/twenty-front/src/modules/ui/utilities/scroll/states/scrollPositionState.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import { createFamilyState } from '@/ui/utilities/state/utils/createFamilyState'; | ||
|
||
export const scrollPositionState = createFamilyState({ | ||
key: 'scroll/scrollPositionState', | ||
defaultValue: 0, | ||
}); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need
react-router
context, put under pathless route withOutlet