-
-
Notifications
You must be signed in to change notification settings - Fork 10.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev' into brophdawg11/link-invalid-to
- Loading branch information
Showing
16 changed files
with
1,918 additions
and
200 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
"@remix-run/router": minor | ||
--- | ||
|
||
- Add support for direct `action` functions to be passed to `router.navigate`. This allows you to skip the creation of a new route to handle the `action` , or you can also override the defined route `action` at the call-site. | ||
|
||
**Defining an `action` at the callsite:** | ||
|
||
```jsx | ||
let routes = [{ path: '/' }]; // No action on route | ||
|
||
// Custom actions will behave as a submission navigation to the current location | ||
router.navigate(null, { | ||
formMethod "post", | ||
formData: new FormData(), | ||
action() { | ||
// You may now define your custom action here | ||
} | ||
}) | ||
``` | ||
|
||
**Overriding an `action` at the call-site:** | ||
|
||
```jsx | ||
let routes = [{ path: '/', action: someAction }]; | ||
router.navigate(null, { | ||
formMethod "post", | ||
formData: new FormData(), | ||
action() { | ||
// This will be called instead of `someAction` | ||
} | ||
}) | ||
``` | ||
|
||
- Add support for direct `action`/`loader` functions to be passed to `router.fetch`. This allows you to skip the creation of a new route to handle the `loader` or `action`, or you can also override the defined route `loader` or `action` at the call-site. | ||
|
||
**Fetching to a direct loader without a defined route:** | ||
|
||
```jsx | ||
let routes = [{ path: "/", action: someAction }]; | ||
// Note no location required | ||
router.fetch("key", "0", null, { | ||
loader() { | ||
// Call this loader for the fetcher and avoid the need for a resource route | ||
}, | ||
}); | ||
``` | ||
|
||
**Fetching to a direct action without a defined route:** | ||
|
||
```jsx | ||
let routes = [{ path: '/', action: someAction }]; | ||
// Note no location required | ||
router.fetch("key", "0", null, { | ||
formMethod "post", | ||
formData: new FormData(), | ||
action() { | ||
// Call this action for the fetcher and avoid the need for a resource route | ||
} | ||
}) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
"react-router-dom": minor | ||
--- | ||
|
||
Add direct `action` function support to `useSubmit`/`fetcher.submit` and direct `loader` support to `fetcher.load`. This allows you to skip the creation of a new route to handle the `action` or `loader`. If both a call-site handler and a route-defined handler exist, the call-site handler will be used. | ||
|
||
**`useSubmit:`** | ||
|
||
```jsx | ||
let router = createBrowserRouter([ | ||
{ | ||
path: "/", | ||
Component() { | ||
let submit = useSubmit(); | ||
|
||
submit(data, { | ||
formMethod: "post", | ||
encType: null, | ||
action({ payload }) { | ||
// You may now define your action here | ||
}, | ||
}); | ||
}, | ||
}, | ||
]); | ||
``` | ||
|
||
**`fetcher.load`/`fetcher.submit`:** | ||
|
||
```jsx | ||
let router = createBrowserRouter([ | ||
{ | ||
path: "/", | ||
Component() { | ||
let fetcher = useFetcher(); | ||
|
||
fetcher.load(() => { | ||
// You may now define a loader here | ||
}); | ||
|
||
fetcher.submit(data, { | ||
formMethod: "post", | ||
encType: null, | ||
action({ payload }) { | ||
// You may now define your action here | ||
}, | ||
}); | ||
}, | ||
}, | ||
]); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
"@remix-run/router": minor | ||
--- | ||
|
||
Add support for a new `payload` parameter for `router.navigate`/`router.fetch` submissions. This allows you to submit data to an `action` without requiring serialization into a `FormData` instance. This `payload` value will be passed unaltered to your `action` function. | ||
|
||
```js | ||
router.navigate("/", { payload: { key: "value" } }); | ||
|
||
function action({ request, payload }) { | ||
// payload => { key: 'value' } | ||
// request.body => null | ||
} | ||
``` | ||
|
||
You may also opt-into serialization of this `payload` into your `request` using the `formEncType` parameter: | ||
|
||
- `formEncType: "application/x-ww-form-urlencoded"` => serializes into `request.formData()` | ||
- `formEncType: "application/json"` => serializes into `request.json()` | ||
- `formEncType: "text/plain"` => serializes into `request.text()` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
--- | ||
"react-router-dom": minor | ||
--- | ||
|
||
- Support better submission and control of serialization of raw payloads through `useSubmit`/`fetcher.submit`. The default `encType` will still be `application/x-www-form-urlencoded` as it is today, but actions will now also receive a raw `payload` parameter when you submit a raw value (not an HTML element, `FormData`, or `URLSearchParams`). | ||
|
||
The default behavior will still serialize into `FormData`: | ||
|
||
```jsx | ||
function Component() { | ||
let submit = useSubmit(); | ||
submit({ key: "value" }); | ||
// navigation.formEncType => "application/x-www-form-urlencoded" | ||
// navigation.formData => FormData instance | ||
// navigation.payload => { key: "Value" } | ||
} | ||
|
||
function action({ request, payload }) { | ||
// request.headers.get("Content-Type") => "application/x-www-form-urlencoded" | ||
// request.formData => FormData instance | ||
// payload => { key: 'value' } | ||
} | ||
``` | ||
|
||
You may opt out of this default serialization using `encType: null`: | ||
|
||
```jsx | ||
function Component() { | ||
let submit = useSubmit(); | ||
submit({ key: "value" }, { encType: null }); | ||
// navigation.formEncType => null | ||
// navigation.formData => undefined | ||
// navigation.payload => { key: "Value" } | ||
} | ||
|
||
function action({ request, payload }) { | ||
// request.headers.get("Content-Type") => null | ||
// request.formData => undefined | ||
// payload => { key: 'value' } | ||
} | ||
``` | ||
|
||
_Note: we plan to change the default behavior of `{ encType: undefined }` to match this "no serialization" behavior in React Router v7. In order to better prepare for this change, we encourage developers to add explicit content types to scenarios in which they are submitting raw JSON objects:_ | ||
|
||
```jsx | ||
function Component() { | ||
let submit = useSubmit(); | ||
|
||
// Change this: | ||
submit({ key: "value" }); | ||
|
||
// To this: | ||
submit({ key: "value" }, { encType: "application/x-www-form-urlencoded" }); | ||
} | ||
``` | ||
|
||
- You may now also opt-into different types of serialization of this `payload` into your `request` using the `formEncType` parameter: | ||
|
||
```js | ||
function Component() { | ||
let submit = useSubmit(); | ||
submit({ key: "value" }, { encType: "application/json" }); | ||
// navigation.formEncType => "application/json" | ||
// navigation.formData => undefined | ||
// navigation.payload => { key: "Value" } | ||
} | ||
|
||
function action({ request, payload }) { | ||
// request.headers.get("Content-Type") => "application/json" | ||
// request.json => { key: 'value' } | ||
// payload => { key: 'value' } | ||
} | ||
``` | ||
|
||
```js | ||
function Component() { | ||
let submit = useSubmit(); | ||
submit({ key: "value" }, { encType: "application/x-www-form-urlencoded" }); | ||
// navigation.formEncType => "application/x-www-form-urlencoded" | ||
// navigation.formData => FormData instance | ||
// navigation.payload => { key: "Value" } | ||
} | ||
|
||
function action({ request, payload }) { | ||
// request.headers.get("Content-Type") => "application/x-www-form-urlencoded" | ||
// request.formData => { key: 'value' } | ||
// payload => { key: 'value' } | ||
} | ||
``` | ||
|
||
```js | ||
function Component() { | ||
let submit = useSubmit(); | ||
submit("Plain ol' text", { encType: "text/plain" }); | ||
// navigation.formEncType => "text/plain" | ||
// navigation.formData => undefined | ||
// navigation.payload => "Plain ol' text" | ||
} | ||
|
||
function action({ request, payload }) { | ||
// request.headers.get("Content-Type") => "text/plain" | ||
// request.text => "Plain ol' text" | ||
// payload => "Plain ol' text" | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.