Skip to content

docs(react): add utility functions page with useIonRouter docs - #4455

Merged
ShaneK merged 6 commits into
major-9.0from
v9/react-utility-functions
Mar 31, 2026
Merged

docs(react): add utility functions page with useIonRouter docs#4455
ShaneK merged 6 commits into
major-9.0from
v9/react-utility-functions

Conversation

@ShaneK

@ShaneKShaneK commented Mar 30, 2026•
edited
Loading

Copy link
Copy Markdown
Member

Resolves#2494

Note: Technically this issue had been resolved before, but I'm extracting utilities out to match Vue's utilities page and to explain in detail our new methods in RR6

Description

Extracts useIonRouter documentation from the navigation page into a dedicated Utility Functions page. Expands coverage with new sections for navigateRoot(), canGoBack(), and back navigation patterns. Updates cross-references in the navigation page to link to the new page.

Change Type

  • Fix
  • Feature
  • Refactor
  • Breaking Change
  • Documentation

Rationale / Problems Fixed

The useIonRouter hook docs were buried at the bottom of the navigation page and only showed a basic type definition with a single example. This moves them to their own page where each method (push, goBack, canGoBack, navigateRoot) gets a focused section with usage examples. Also documents the navigateRoot method which is new to RR6.

Preview

React Utility Functions

@ShaneK
ShaneK requested a review from a team as a code ownerMarch 30, 2026 12:49
@ShaneK
ShaneK requested review from gnbm and removed request for a teamMarch 30, 2026 12:49
@vercel

vercelBot commented Mar 30, 2026•
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
ionic-docsReadyReadyPreview, CommentMar 30, 2026 7:01pm

Request Review

thetaPC
thetaPC reviewed Mar 30, 2026
View reviewed changes
Comment threadsidebars.js Outdated
thetaPC
thetaPC requested changes Mar 30, 2026
View reviewed changes
Comment threaddocs/react/navigation.md
Comment threaddocs/react/utility-functions.md
Comment threaddocs/react/navigation.md Outdated
Comment threaddocs/react/navigation.md Outdated
Comment threaddocs/react/navigation.md Outdated
Comment threaddocs/react/utility-functions.md Outdated
Comment threaddocs/react/utility-functions.md Outdated
Comment threaddocs/react/utility-functions.md Outdated
Comment threaddocs/react/utility-functions.md Outdated
Comment threaddocs/react/utility-functions.md
thetaPC
thetaPC approved these changes Mar 31, 2026
View reviewed changes

@thetaPCthetaPC left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@ShaneK
ShaneK merged commit fa4901b into major-9.0Mar 31, 2026
4 checks passed
@ShaneK
ShaneK deleted the v9/react-utility-functions branch March 31, 2026 01:55
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thetaPCthetaPCthetaPC approved these changes
@gnbmgnbmAwaiting requested review from gnbmgnbm was automatically assigned from ionic-team/framework

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ShaneK@thetaPC