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.

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

Start adopting React Router v6 API using compatibility layer #2542

Merged
merged 1 commit into from
Oct 27, 2022

Conversation

AlanGreene
Copy link
Member

Changes

#2452

React Router v6 contains a number of breaking changes, however they have provided a helpful compatibility layer which allows us to start adopting the new APIs while still using v5. This means we don't have to update everything in one go (which would also require updating to React 18).

Change implemented so far:

  • use hooks from new API, useHistory replaced by useNavigate
  • no standalone Route components, must be inside a Switch
  • use CompatRoute to begin consuming the new APIs
  • implement replacement for useRouteMatch from v5 which is not available in the new API. This also allows us to clean up the NamespacedRoute and related namespacedMatch used for navigation when switching namespaces avoiding the need to explicitly pass the allNamespacesPath on each namespaced resource details page.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

See the contribution guide
for more details.

React Router v6 contains a number of breaking changes, however they
have provided a helpful compatibility layer which allows us to start
adopting the new APIs while still using v5. This means we don't have
to update everything in one go (which would also require updating to
React 18).

Change implemented so far:
- use hooks from new API, `useHistory` replaced by `useNavigate`
- no standalone `Route` components, must be inside a `Switch`
- use `CompatRoute` to begin consuming the new APIs
- implement replacement for `useRouteMatch` from v5 which is not
  available in the new API. This also allows us to clean up the
  `NamespacedRoute` and related `namespacedMatch` used for navigation
  when switching namespaces avoiding the need to explicitly pass
  the `allNamespacesPath` on each namespaced resource details page.
@tekton-robot tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 21, 2022
@AlanGreene AlanGreene removed the request for review from skaegi October 21, 2022 13:40
Copy link
Contributor

@briangleeson briangleeson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 27, 2022
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: briangleeson

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 27, 2022
@tekton-robot tekton-robot merged commit 9c354e9 into tektoncd:main Oct 27, 2022
@AlanGreene AlanGreene deleted the react_router_compat branch October 27, 2022 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants