|
| 1 | +--- |
| 2 | +"@remix-run/router": minor |
| 3 | +--- |
| 4 | + |
| 5 | +Add support for a new `payload` parameter for `router.navigate` and `router.fetch` submissions. This allows you to submit data to an action without requiring serialization into a `FormData` instance. This `payload` value wil be passed unaltered to your action function. |
| 6 | + |
| 7 | +```js |
| 8 | +router.navigate("/", { payload: { key: "value" } }); |
| 9 | + |
| 10 | +function action({ request, payload }) { |
| 11 | + // payload is `{ key: 'value' }` |
| 12 | + // request.body is `null` |
| 13 | +} |
| 14 | +``` |
| 15 | + |
| 16 | +You may also opt-into serialization of this `payload` into your `request` using the `formEncType` parameter: |
| 17 | + |
| 18 | +```js |
| 19 | +router.navigate("/", { |
| 20 | + payload: { key: "value" }, |
| 21 | + formEncType: "application/json", |
| 22 | +}); |
| 23 | + |
| 24 | +function action({ request, payload }) { |
| 25 | + // payload is `{ key: 'value' }` |
| 26 | + // await request.text() is '{"key":"value"}' |
| 27 | +} |
| 28 | +``` |
| 29 | + |
| 30 | +```js |
| 31 | +router.navigate("/", { |
| 32 | + payload: { key: "value" }, |
| 33 | + formEncType: "application/x-www-form-urlencoded", |
| 34 | +}); |
| 35 | + |
| 36 | +function action({ request, payload }) { |
| 37 | + // payload is `{ key: 'value' }` |
| 38 | + // await request.formData() is a `FormData` instance with a single entry of key=value |
| 39 | +} |
| 40 | +``` |
| 41 | + |
| 42 | +```js |
| 43 | +router.navigate("/", { |
| 44 | + payload: "Plain ol' text", |
| 45 | + formEncType: "text/plain", |
| 46 | +}); |
| 47 | + |
| 48 | +function action({ request, payload }) { |
| 49 | + // payload is "Plain ol' text" |
| 50 | + // await request.text() is "Plain ol' text" |
| 51 | +} |
| 52 | +``` |
0 commit comments