Skip to content

Commit 86276e5

Browse files
docs: update navigation descriptions (#13639)
* . * clarify --------- Co-authored-by: Rich Harris <[email protected]>
1 parent 81e4314 commit 86276e5

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

packages/kit/src/exports/public.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,8 +1046,8 @@ export interface NavigationTarget<
10461046

10471047
/**
10481048
* - `enter`: The app has hydrated/started
1049-
* - `form`: The user submitted a `<form>` with a GET method
1050-
* - `leave`: The user is leaving the app by closing the tab or using the back/forward buttons to go to a different document
1049+
* - `form`: The user submitted a `<form method="GET">`
1050+
* - `leave`: The app is being left either because the tab is being closed or a navigation to a different document is occurring
10511051
* - `link`: Navigation was triggered by a link click
10521052
* - `goto`: Navigation was triggered by a `goto(...)` call or a redirect
10531053
* - `popstate`: Navigation was triggered by back/forward navigation
@@ -1065,7 +1065,7 @@ export interface Navigation {
10651065
to: NavigationTarget | null;
10661066
/**
10671067
* The type of navigation:
1068-
* - `form`: The user submitted a `<form>`
1068+
* - `form`: The user submitted a `<form method="GET">`
10691069
* - `leave`: The app is being left either because the tab is being closed or a navigation to a different document is occurring
10701070
* - `link`: Navigation was triggered by a link click
10711071
* - `goto`: Navigation was triggered by a `goto(...)` call or a redirect
@@ -1103,7 +1103,7 @@ export interface BeforeNavigate extends Navigation {
11031103
export interface OnNavigate extends Navigation {
11041104
/**
11051105
* The type of navigation:
1106-
* - `form`: The user submitted a `<form>`
1106+
* - `form`: The user submitted a `<form method="GET">`
11071107
* - `link`: Navigation was triggered by a link click
11081108
* - `goto`: Navigation was triggered by a `goto(...)` call or a redirect
11091109
* - `popstate`: Navigation was triggered by back/forward navigation
@@ -1122,7 +1122,7 @@ export interface AfterNavigate extends Omit<Navigation, 'type'> {
11221122
/**
11231123
* The type of navigation:
11241124
* - `enter`: The app has hydrated/started
1125-
* - `form`: The user submitted a `<form>`
1125+
* - `form`: The user submitted a `<form method="GET">`
11261126
* - `link`: Navigation was triggered by a link click
11271127
* - `goto`: Navigation was triggered by a `goto(...)` call or a redirect
11281128
* - `popstate`: Navigation was triggered by back/forward navigation

packages/kit/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,8 +1023,8 @@ declare module '@sveltejs/kit' {
10231023

10241024
/**
10251025
* - `enter`: The app has hydrated/started
1026-
* - `form`: The user submitted a `<form>` with a GET method
1027-
* - `leave`: The user is leaving the app by closing the tab or using the back/forward buttons to go to a different document
1026+
* - `form`: The user submitted a `<form method="GET">`
1027+
* - `leave`: The app is being left either because the tab is being closed or a navigation to a different document is occurring
10281028
* - `link`: Navigation was triggered by a link click
10291029
* - `goto`: Navigation was triggered by a `goto(...)` call or a redirect
10301030
* - `popstate`: Navigation was triggered by back/forward navigation
@@ -1042,7 +1042,7 @@ declare module '@sveltejs/kit' {
10421042
to: NavigationTarget | null;
10431043
/**
10441044
* The type of navigation:
1045-
* - `form`: The user submitted a `<form>`
1045+
* - `form`: The user submitted a `<form method="GET">`
10461046
* - `leave`: The app is being left either because the tab is being closed or a navigation to a different document is occurring
10471047
* - `link`: Navigation was triggered by a link click
10481048
* - `goto`: Navigation was triggered by a `goto(...)` call or a redirect
@@ -1080,7 +1080,7 @@ declare module '@sveltejs/kit' {
10801080
export interface OnNavigate extends Navigation {
10811081
/**
10821082
* The type of navigation:
1083-
* - `form`: The user submitted a `<form>`
1083+
* - `form`: The user submitted a `<form method="GET">`
10841084
* - `link`: Navigation was triggered by a link click
10851085
* - `goto`: Navigation was triggered by a `goto(...)` call or a redirect
10861086
* - `popstate`: Navigation was triggered by back/forward navigation
@@ -1099,7 +1099,7 @@ declare module '@sveltejs/kit' {
10991099
/**
11001100
* The type of navigation:
11011101
* - `enter`: The app has hydrated/started
1102-
* - `form`: The user submitted a `<form>`
1102+
* - `form`: The user submitted a `<form method="GET">`
11031103
* - `link`: Navigation was triggered by a link click
11041104
* - `goto`: Navigation was triggered by a `goto(...)` call or a redirect
11051105
* - `popstate`: Navigation was triggered by back/forward navigation

0 commit comments

Comments
 (0)