跳到内容

Form

<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 prop 是传递 string 还是 function

  • actionstring 时,<Form> 的行为类似于使用 GET 方法的原生 HTML 表单。表单数据被编码到 URL 中作为搜索参数,当表单提交时,它会导航到指定的 URL。此外,Next.js
    • 在表单提交时执行客户端导航,而不是完整的页面重新加载。这样可以保留共享的 UI 和客户端状态。

action (string) Props

action 是字符串时,<Form> 组件支持以下 props

Prop示例类型必需
actionaction="/search"string (URL 或相对路径)
replacereplace={false}boolean-
scrollscroll={true}boolean-
  • action:表单提交时导航到的 URL 或路径。
    • 空字符串 "" 将导航到同一路由并更新搜索参数。
  • replace:替换当前历史记录状态,而不是将新状态推送到浏览器的历史记录堆栈。默认为 false
  • scroll:控制导航期间的滚动行为。默认为 true,这意味着它将滚动到新路由的顶部,并为后退和前进导航保持滚动位置。

注意事项

  • onSubmit:可用于处理表单提交逻辑。但是,调用 event.preventDefault() 将覆盖 <Form> 行为,例如导航到指定的 URL。
  • methodencTypetarget:不受支持,因为它们会覆盖 <Form> 行为。
    • 同样,formMethodformEncTypeformTarget 可用于分别覆盖 methodencTypetarget props,使用它们将回退到原生浏览器行为。
    • 如果需要使用这些 props,请改用 HTML <form> 元素。
  • <input type="file">:当 action 是字符串时,使用此输入类型将匹配浏览器行为,方法是提交文件名而不是文件对象。