Skip to content
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

Jump to bottom

docs: document scroll: false option #51602

Closed
wants to merge 10 commits into from
Closed

docs: document scroll: false option #51602

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a0b02b7
chore(ts): hide internal APIs
balazsorban44 Jun 21, 2023
a3f803a
Merge branch 'canary' into chore/hide-internal-apis
balazsorban44 Jun 28, 2023
93ff07e
Merge branch 'canary' into chore/hide-internal-apis
kodiakhq[bot] Jun 29, 2023
b2ef39b
Merge branch 'canary' into chore/hide-internal-apis
balazsorban44 Jul 18, 2023
0f533a8
update
balazsorban44 Jul 18, 2023
e6af67d
expose/document `scroll` navigation option
balazsorban44 Jul 19, 2023
2a69f4e
correct default value
balazsorban44 Jul 19, 2023
0ee983b
don't hide `NavigateOptions`
balazsorban44 Jul 19, 2023
499c9a7
remove empty line
balazsorban44 Jul 19, 2023
3a59880
remove
balazsorban44 Jul 19, 2023
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
7 changes: 5 additions & 2 deletions packages/next/src/client/components/app-router.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
import type {
CacheNode,
AppRouterInstance,
NavigateOptions,
} from '../../shared/lib/app-router-context'
import type {
FlightRouterState,
Expand Down Expand Up @@ -303,7 +304,8 @@ function Router({
})
})
},
replace: (href, options = {}) => {
// options is internal, hidden from TS users
replace: (href, options: NavigateOptions = {}) => {
startTransition(() => {
navigate(
href,
Expand All @@ -313,7 +315,8 @@ function Router({
)
})
},
push: (href, options = {}) => {

push: (href, options: NavigateOptions = {}) => {
startTransition(() => {
navigate(
href,
Expand Down
5 changes: 5 additions & 0 deletions packages/next/src/shared/lib/app-router-context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ export type CacheNode =
export interface NavigateOptions {
/** @internal */
forceOptimisticNavigation?: boolean
/** @internal */
scroll?: boolean
}

Expand All @@ -94,11 +95,15 @@ export interface AppRouterInstance {
* Navigate to the provided href.
* Pushes a new history entry.
*/
push(href: string): void
/** @internal */
push(href: string, options?: NavigateOptions): void
/**
* Navigate to the provided href.
* Replaces the current history entry.
*/
replace(href: string): void
/** @internal */
replace(href: string, options?: NavigateOptions): void
/**
* Prefetch the provided href.
Expand Down