Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add <form> Component reference documentation #6312

Merged
merged 8 commits into from
Oct 26, 2023
Merged

Conversation

mattcarrollcode
Copy link
Contributor

@mattcarrollcode mattcarrollcode commented Sep 22, 2023

Add initial reference documentation for the <form> Component

Preview

@github-actions
Copy link

github-actions bot commented Sep 22, 2023

Size changes

📦 Next.js Bundle Analysis for react-dev

This analysis was generated by the Next.js Bundle Analysis action. 🤖

One Page Changed Size

The following page changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/[[...markdownPath]] 78.83 KB (🟡 +12 B) 182.57 KB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 10% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

Copy link
Contributor

@elicwhite elicwhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is super cool! I appreciate the examples. As this gets closer to shipping we'll want to figure out more user friendly and less code-centric examples of course. I'm sure you have a list of things you want to do and I jumped the gun on reviewing this anyways 😀

src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
@eps1lon
Copy link
Collaborator

eps1lon commented Oct 1, 2023

FYI:

  • stable preview link for latest changes for branches on upstream (such as this branch): react-dev-git-<branch-name>-fbopensource.vercel.app
  • stable preview link for latest changes for branches forks: react-dev-git-fork-<username>-<branch-name>-fbopensource.vercel.app

More details in https://vercel.com/docs/deployments/generated-urls and https://github.com/orgs/vercel/discussions/970#discussioncomment-3918729 for forks.

src/content/reference/react-dom/components/input.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
@mattcarrollcode
Copy link
Contributor Author

mattcarrollcode commented Oct 24, 2023

In person code review notes with @lunaleaps :

  • refer the funciton passed to the action prop as a "action"
  • rephrase "form action" to a "the action passed to form"
  • useFormState error example: why do we need to use useFormState? call out that if you use a client action that calls a server action that returns and error disables progressive enhancement

Copy link
Contributor

@davidmccabe davidmccabe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great.

src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
src/content/reference/react-dom/components/form.md Outdated Show resolved Hide resolved
Copy link
Contributor

@lunaleaps lunaleaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this! Thanks for all the updates. I have some suggestions -- mostly spelling and occasional sentence re-ordering but those aren't blocking!

I think the only blocking thing is the error boundary example not working

@mattcarrollcode mattcarrollcode merged commit 4b333ca into main Oct 26, 2023
3 checks passed
@rickhanlonii rickhanlonii deleted the form-ref-docs branch April 29, 2024 02:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants