表单
<Form> 组件扩展了 HTML <form> 元素,以提供 提交时的客户端导航和渐进式增强。
它对于更新 URL 搜索参数的表单很有用,因为它减少了实现上述功能所需的样板代码。
基本用法
/ui/search.js
import Form from 'next/form'
export default function Page() {
return (
<Form action="/search">
{/* On submission, the input value will be appended to
the URL, e.g. /search?query=abc */}
<input name="query" />
<button type="submit">Submit</button>
</Form>
)
}参考
<Form> 组件的行为取决于 action 属性传入的是 string 还是 function。
- 当
action是字符串时,<Form>的行为类似于使用GET方法的原生 HTML 表单。表单数据编码为 URL 中的搜索参数,提交表单时会导航到指定的 URL。此外,Next.js- 在提交表单时执行客户端导航,而不是完整的页面重载。这会保留共享 UI 和客户端状态。
action (字符串) 属性
当 action 是字符串时,<Form> 组件支持以下属性
| 属性 | 示例 | 类型 | 必需 |
|---|---|---|---|
action | action="/search" | string (URL 或相对路径) | 是 |
replace | replace={false} | boolean | - |
scroll | scroll={true} | boolean | - |
action:提交表单时要导航到的 URL 或路径。- 空字符串
""将导航到具有更新搜索参数的相同路由。
- 空字符串
replace:替换当前历史状态,而不是向浏览器的历史记录堆栈中推入新的历史状态。默认为false。scroll:控制导航期间的滚动行为。默认为true,这意味着它将滚动到新路由的顶部,并为前后导航保持滚动位置。
注意事项
onSubmit:可用于处理表单提交逻辑。但是,调用event.preventDefault()将覆盖<Form>的行为,例如导航到指定的 URL。method、encType、target:不支持,因为它们会覆盖<Form>的行为。- 类似地,
formMethod、formEncType和formTarget可分别用于覆盖method、encType和target属性,使用它们将回退到原生浏览器行为。 - 如果需要使用这些属性,请改用 HTML
<form>元素。
- 类似地,
<input type="file">:当action为字符串时使用此输入类型,将通过提交文件名而不是文件对象来匹配浏览器行为。
这有帮助吗?