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

Navigator: internal refactor in preparation for stabilization #65671

Merged
merged 6 commits into from
Sep 26, 2024

Conversation

ciampo
Copy link
Contributor

@ciampo ciampo commented Sep 26, 2024

What?

Extracted from #64613
Part of #59418

This PR refactor some internal code of the Navigator component in preparation for the upcoming stabilization.

Why?

See #59418

How?

  • Moved current exports from index.ts to a legacy.ts file, which will make room for a new index.ts in a future PR
  • Moved all JSDocs to the legacy.ts file, which will allow for a different set of JSDocs to be applied to the stable exports
  • Renamed some internal variables "navigator provider" to "navigator", without affecting the exported component name

I don't think a CHANGELOG entry is necessary.

Testing Instructions

  • No runtime changes
  • Project builds, tests pass
  • Smoke test Storybook and block editor, everything should work as before

@ciampo ciampo requested a review from ajitbohra as a code owner September 26, 2024 10:05
@ciampo ciampo requested a review from a team September 26, 2024 10:05
Copy link

github-actions bot commented Sep 26, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: ciampo <[email protected]>
Co-authored-by: tyxla <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@ciampo ciampo self-assigned this Sep 26, 2024
@ciampo ciampo added [Package] Components /packages/components [Type] Code Quality Issues or PRs that relate to code quality labels Sep 26, 2024
@ciampo ciampo force-pushed the feat/navigator-refactor-out-legacy branch from 273b58c to aa5f7c4 Compare September 26, 2024 10:23
Copy link
Member

@tyxla tyxla left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Thanks for moving it to a separate PR, it does help a lot with reviewing 🚀

@ciampo ciampo enabled auto-merge (squash) September 26, 2024 12:50
@ciampo ciampo merged commit 79efa22 into trunk Sep 26, 2024
61 of 62 checks passed
@ciampo ciampo deleted the feat/navigator-refactor-out-legacy branch September 26, 2024 13:07
@github-actions github-actions bot added this to the Gutenberg 19.4 milestone Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants