Skip to content

Commit

Permalink
fix: Put back type for NavigateOptions.scroll (#59001)
Browse files Browse the repository at this point in the history
It seems like in
24b2ff1#diff-421107ce62efb02560358d25c5eb086d5d82d2ad1c7c4929ebfb768c2ea1c973
`forceOptimisticNavigation` was removed, but the `@internal` flag that
was originally assigned to this option remained in place.

Due to this, it seems like `scroll` is missing in the built types (see
[`app-router-context.shared-runtime.d.ts` in the latest
canary](https://unpkg.com/browse/next@14.0.4-canary.18/dist/shared/lib/app-router-context.shared-runtime.d.ts)).

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

Co-authored-by: Zack Tanner <zacktanner@gmail.com>
  • Loading branch information
amannn and ztanner committed Nov 28, 2023
1 parent cd66493 commit 8d1c619
Showing 1 changed file with 0 additions and 1 deletion.
Expand Up @@ -68,7 +68,6 @@ export type CacheNode =
}

export interface NavigateOptions {
/** @internal */
scroll?: boolean
}

Expand Down

0 comments on commit 8d1c619

Please sign in to comment.