Skip to content

docs(vue): update useIonRouter replace direction #4794

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

Open
ShaneK wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(vue): update useIonRouter replace direction #4794

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/vue/utility-functions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ interface UseIonRouterResult {
forward: (routerAnimation?: AnimationBuilder) => void;
navigate: (
location: string | Location,
routerDirection?: 'forward' | 'back' | 'root',
routerDirection?: 'forward' | 'back' | 'root' | 'none',
routerAction?: 'push' | 'pop' | 'replace',
routerAnimation?: AnimationBuilder
) => void;
Expand All @@ -80,7 +80,7 @@ useIonRouter(): UseIonRouterResult;

- The `push` method is the equivalent of calling `ionRouter.navigate(location, 'forward', 'push', animation)`.

- The `replace` method is the equivalent of calling `ionRouter.navigate(location, 'root', 'replace', animation)`.
- The `replace` method is the equivalent of calling `ionRouter.navigate(location, 'none', 'replace', animation)`. It swaps the current page for the new one and keeps the pages beneath it, so the back button still returns to the previous page. No transition plays unless an `animation` is passed. To clear the navigation stack instead, call `ionRouter.navigate(location, 'root', 'replace', animation)`.

Refer to the [Vue Navigation Documentation](./navigation#navigating-using-useionrouter) for more usage examples.

Expand Down
Loading