Skip to content

feat(router-core): allow dynamic ViewTransition types #4031

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.

Sign up for GitHub

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

Merged
SeanCassiere merged 2 commits into from
Apr 23, 2025
Merged

feat(router-core): allow dynamic ViewTransition types #4031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1268f86
feat(react-router): accept function as ViewTransitionOptions['types']
burakcan Apr 22, 2025
419373a
apply code-review suggestion from @SeanCassiere
SeanCassiere Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion examples/react/view-transitions/src/main.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,32 @@ const router = createRouter({
scrollRestoration: true,
/*
Using defaultViewTransition would prevent the need to
manually add `viewTransition: true` to every navigation
manually add `viewTransition: true` to every navigation.

If defaultViewTransition.types is a function, it will be called with the
location change info and should return an array of view transition types.
This is useful if you want to have different view transitions depending on
the navigation's specifics.

An example use case is sliding in a direction based on the index of the
previous and next routes when navigating via browser history back and forth.
*/
// defaultViewTransition: true
// OR
// defaultViewTransition: {
// types: ({ fromLocation, toLocation }) => {
// let direction = 'none'

// if (fromLocation) {
// const fromIndex = fromLocation.state.__TSR_index
// const toIndex = toLocation.state.__TSR_index

// direction = fromIndex > toIndex ? 'right' : 'left'
// }

// return [`slide-${direction}`]
// },
// },
})

// Register things for typesafety
Expand Down
25 changes: 23 additions & 2 deletions packages/router-core/src/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,15 @@ export type AnyRouterWithContext<TContext> = RouterCore<
export type AnyRouter = RouterCore<any, any, any, any, any>

export interface ViewTransitionOptions {
types: Array<string>
types:
| Array<string>
| ((locationChangeInfo: {
fromLocation?: ParsedLocation
toLocation: ParsedLocation
pathChanged: boolean
hrefChanged: boolean
hashChanged: boolean
}) => Array<string>)
}

export function defaultSerializeError(err: unknown) {
Expand Down Expand Up @@ -2172,9 +2180,22 @@ export class RouterCore<
typeof shouldViewTransition === 'object' &&
this.isViewTransitionTypesSupported
) {
const next = this.latestLocation
const prevLocation = this.state.resolvedLocation

const resolvedViewTransitionTypes =
typeof shouldViewTransition.types === 'function'
? shouldViewTransition.types(
getLocationChangeInfo({
resolvedLocation: prevLocation,
location: next,
}),
)
: shouldViewTransition.types

startViewTransitionParams = {
update: fn,
types: shouldViewTransition.types,
types: resolvedViewTransitionTypes,
}
} else {
startViewTransitionParams = fn
Expand Down