Skip to content

Commit

Permalink
Revert "Add better control over submission serialization (#10342)"
Browse files Browse the repository at this point in the history
This reverts commit 9d81bf6.
  • Loading branch information
brophdawg11 committed Apr 26, 2023
1 parent 4bb7e48 commit f92aa2e
Show file tree
Hide file tree
Showing 14 changed files with 140 additions and 1,115 deletions.
20 changes: 0 additions & 20 deletions .changeset/raw-payload-submission-router.md

This file was deleted.

105 changes: 0 additions & 105 deletions .changeset/raw-payload-submission.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/hooks/use-fetcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ function SomeComponent() {
// build your UI with these properties
fetcher.state;
fetcher.formData;
fetcher.payload;
fetcher.formMethod;
fetcher.formAction;
fetcher.data;
Expand Down Expand Up @@ -133,8 +132,6 @@ export function useIdleLogout() {
}
```

`fetcher.submit` is a wrapper around a [`useSubmit`][use-submit] call for the fetcher instance, so it also accepts the same options as `useSubmit`.

If you want to submit to an index route, use the [`?index` param][indexsearchparam].

If you find yourself calling this function inside of click handlers, you can probably simplify your code by using `<fetcher.Form>` instead.
Expand Down Expand Up @@ -203,8 +200,6 @@ function TaskCheckbox({ task }) {
}
```

If you opt-out of serialization using `encType: null`, then `fetcher.formData` will be `undefined` and your data will be exposed on `fetcher.payload`.

## `fetcher.formAction`

Tells you the action url the form is being submitted to.
Expand All @@ -229,15 +224,10 @@ fetcher.formMethod; // "post"

<docs-warning>The `fetcher.formMethod` field is lowercase without the `future.v7_normalizeFormMethod` [Future Flag][api-development-strategy]. This is being normalized to uppercase to align with the `fetch()` behavior in v7, so please upgrade your React Router v6 applications to adopt the uppercase HTTP methods.</docs-warning>

## `fetcher.payload`

Any POST, PUT, PATCH, or DELETE that started from a `fetcher.submit(payload, { encType: null })` will have your `payload` value represented in `fetcher.payload`.

[loader]: ../route/loader
[action]: ../route/action
[pickingarouter]: ../routers/picking-a-router
[indexsearchparam]: ../guides/index-search-param
[link]: ../components/link
[form]: ../components/form
[api-development-strategy]: ../guides/api-development-strategy
[use-submit]: ./use-submit.md
7 changes: 0 additions & 7 deletions docs/hooks/use-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ function SomeComponent() {
navigation.state;
navigation.location;
navigation.formData;
navigation.payload;
navigation.formAction;
navigation.formMethod;
}
Expand Down Expand Up @@ -91,14 +90,8 @@ let isRedirecting =

Any POST, PUT, PATCH, or DELETE navigation that started from a `<Form>` or `useSubmit` will have your form's submission data attached to it. This is primarily useful to build "Optimistic UI" with the `submission.formData` [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) object.

If you opt-out of serialization using `encType: null`, then `navigation.formData` will be `undefined` and your data will be exposed on `navigation.payload`.

In the case of a GET form submission, `formData` will be empty and the data will be reflected in `navigation.location.search`.

## `navigation.payload`

Any POST, PUT, PATCH, or DELETE navigation that started from a `useSubmit(payload, { encType: null })` will have your `payload` value represented in `navigation.payload`.

## `navigation.location`

This tells you what the next [location][location] is going to be.
Expand Down
44 changes: 0 additions & 44 deletions docs/hooks/use-submit.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,50 +78,6 @@ formData.append("cheese", "gouda");
submit(formData);
```

### Payload Serialization

You may also submit raw JSON to your `action` and the default behavior will be to encode the key/values into `FormData`:

```tsx
let obj = { key: "value" };
submit(obj); // -> request.formData()
```

You may also choose which type of serialization you'd like via the `encType` option:

```tsx
let obj = { key: "value" };
submit(obj, {
encType: "application/x-www-form-urlencoded",
}); // -> request.formData()
```

```tsx
let obj = { key: "value" };
submit(obj, { encType: "application/json" }); // -> request.json()
```

```tsx
let text = "Plain ol' text";
submit(obj, { encType: "text/plain" }); // -> request.text()
```

<docs-warn>In future versions of React Router, the default behavior will not serialize raw JSON payloads. If you are submitting raw JSON today it's recommended to specify an explicit `encType`.</docs-warn>

### Opting out of serialization

Sometimes in a client-side application, it's overkill to require serialization into `request.formData` when you have a raw JSON object in your component and want to submit it to your `action` directly. If you'd like to opt out of serialization, you can pass `encType: null` to your second options argument, and your data will be sent to your action function verbatim as a `payload` parameter:

```tsx
let obj = { key: "value" };
submit(obj, { encType: null });

function action({ request, payload }) {
// payload is `obj` from your component
// request.body === null
}
```

## Submit options

The second argument is a set of options that map directly to form submission attributes:
Expand Down
17 changes: 0 additions & 17 deletions docs/route/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,22 +101,6 @@ formData.get("lyrics");

For more information on `formData` see [Working with FormData][workingwithformdata].

### Opt-in serialization types

Note that when using [`useSubmit`][usesubmit] you may also pass `encType: "application/json"` or `encType: "text/plain"` to instead serialize your payload into `request.json()` or `request.text()`.

## `payload`

A `payload` is provided to your action when you submit imperatively with [`useSubmit`][usesubmit] and provide a raw javascript value. This value might also be serialized into the request depending on the `encType`.

```jsx
function Component {
let submit = useSubmit();
submit({ key: "value" }, { encType: null });
// action payload is { key: 'value' }
}
```

## Returning Responses

While you can return anything you want from an action and get access to it from [`useActionData`][useactiondata], you can also return a web [Response][response].
Expand Down Expand Up @@ -160,6 +144,5 @@ For more details and expanded use cases, read the [errorElement][errorelement] d
[form]: ../components/form
[workingwithformdata]: ../guides/form-data
[useactiondata]: ../hooks/use-action-data
[usesubmit]: ../hooks/use-submit
[returningresponses]: ./loader#returning-responses
[createbrowserrouter]: ../routers/create-browser-router
1 change: 0 additions & 1 deletion docs/route/should-revalidate.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ interface ShouldRevalidateFunction {
formAction?: Submission["formAction"];
formEncType?: Submission["formEncType"];
formData?: Submission["formData"];
payload?: Submission["payload"];
actionResult?: DataResult;
defaultShouldRevalidate: boolean;
}): boolean;
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,10 @@
"none": "15.4 kB"
},
"packages/react-router-dom/dist/react-router-dom.production.min.js": {
"none": "12 kB"
"none": "11.8 kB"
},
"packages/react-router-dom/dist/umd/react-router-dom.production.min.js": {
"none": "17.9 kB"
"none": "17.7 kB"
}
}
}
Loading

0 comments on commit f92aa2e

Please sign in to comment.