Skip to content

Commit 6e57094

Browse files
docs: add warnings on unstable API docs that were deprecated in React… (#10667)
1 parent c8b9acf commit 6e57094

File tree

4 files changed

+7
-1
lines changed

4 files changed

+7
-1
lines changed

docs/guides/file-uploads.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: File Uploads
33
---
44

5-
<docs-warning>This doc is a WIP: It was extracted from the API docs for file uploads, so it's a bit out of context. We intend to re-write this as a general guide on file uploads.</docs-warning>
5+
<docs-warning>The APIs covered in this guide were removed in React Router v7. See <a href="https://reactrouter.com/how-to/file-uploads">the React Router guide to file uploads</a> for the recommended approach.</docs-warning>
66

77
Most of the time, you'll probably want to proxy the file to a file host.
88

docs/utils/parse-multipart-form-data.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: unstable_parseMultipartFormData
44

55
# `unstable_parseMultipartFormData`
66

7+
<docs-warning>This API is removed in React Router v7. See <a href="https://reactrouter.com/how-to/file-uploads">the React Router guide to file uploads</a> for the recommended alternative API.</docs-warning>
8+
79
Allows you to handle multipart forms (file uploads) for your app.
810

911
It would be useful to understand [the Browser File API][the-browser-file-api] to know how to use this API.

docs/utils/unstable-create-file-upload-handler.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ toc: false
55

66
# `unstable_createFileUploadHandler`
77

8+
<docs-warning>This API is removed in React Router v7. See <a href="https://reactrouter.com/how-to/file-uploads">the React Router guide to file uploads</a> for the recommended alternative API.</docs-warning>
9+
810
A Node.js upload handler that will write parts with a filename to disk to keep them out of memory, parts without a filename will not be parsed. Should be composed with another upload handler.
911

1012
**Example:**

docs/utils/unstable-create-memory-upload-handler.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ toc: false
55

66
# `unstable_createMemoryUploadHandler`
77

8+
<docs-warning>This API is removed in React Router v7. See <a href="https://reactrouter.com/how-to/file-uploads">the React Router guide to file uploads</a> for the recommended alternative API.</docs-warning>
9+
810
**Example:**
911

1012
```tsx

0 commit comments

Comments
 (0)