提交处理

提交处理

向提交处理传递额外数据

您可能需要多种提交行为类型，例如返回其他页面或停留在当前表单。可以通过指定 onSubmitMeta 属性实现这一需求，该元数据将被传递至 onSubmit 函数。

注意：若调用 form.handleSubmit() 时未提供元数据，将使用预设的默认值。

tsx

import { useForm } from '@tanstack/react-form'

type FormMeta = {
  submitAction: 'continue' | 'backToMenu' | null
}

// 调用 form.handleSubmit() 时不强制要求传递元数据
// 指定未传递元数据时的默认值
const defaultMeta: FormMeta = {
  submitAction: null,
}

function App() {
  const form = useForm({
    defaultValues: {
      data: '',
    },
    // 定义提交时期望接收的元数据值
    onSubmitMeta: defaultMeta,
    onSubmit: async ({ value, meta }) => {
      // 处理通过 handleSubmit 传递的值
      console.log(`Selected action - ${meta.submitAction}`, value)
    },
  })

  return (
    <form
      onSubmit={(e) => {
        e.preventDefault()
        e.stopPropagation()
      }}
    >
      {/* ... */}
      <button
        type="submit"
        // 覆盖 onSubmitMeta 中指定的默认值
        onClick={() => form.handleSubmit({ submitAction: 'continue' })}
      >
        提交并继续
      </button>
      <button
        type="submit"
        onClick={() => form.handleSubmit({ submitAction: 'backToMenu' })}
      >
        提交并返回菜单
      </button>
    </form>
  )
}

import { useForm } from '@tanstack/react-form'

type FormMeta = {
  submitAction: 'continue' | 'backToMenu' | null
}

// 调用 form.handleSubmit() 时不强制要求传递元数据
// 指定未传递元数据时的默认值
const defaultMeta: FormMeta = {
  submitAction: null,
}

function App() {
  const form = useForm({
    defaultValues: {
      data: '',
    },
    // 定义提交时期望接收的元数据值
    onSubmitMeta: defaultMeta,
    onSubmit: async ({ value, meta }) => {
      // 处理通过 handleSubmit 传递的值
      console.log(`Selected action - ${meta.submitAction}`, value)
    },
  })

  return (
    <form
      onSubmit={(e) => {
        e.preventDefault()
        e.stopPropagation()
      }}
    >
      {/* ... */}
      <button
        type="submit"
        // 覆盖 onSubmitMeta 中指定的默认值
        onClick={() => form.handleSubmit({ submitAction: 'continue' })}
      >
        提交并继续
      </button>
      <button
        type="submit"
        onClick={() => form.handleSubmit({ submitAction: 'backToMenu' })}
      >
        提交并返回菜单
      </button>
    </form>
  )
}

使用标准模式转换数据

虽然 Tanstack Form 提供标准模式支持 (Standard Schema) 进行验证，但不会保留模式输出的数据。

传递给 onSubmit 函数的值始终是输入数据。要获取标准模式的输出数据，需在 onSubmit 函数中进行解析：

tsx

const schema = z.object({
  age: z.string().transform((age) => Number(age)),
})

// Tanstack Form 使用标准模式的输入类型
const defaultValues: z.input<typeof schema> = {
  age: '13',
}

const form = useForm({
  defaultValues,
  validators: {
    onChange: schema,
  },
  onSubmit: ({ value }) => {
    const inputAge: string = value.age
    // 通过模式解析获取转换后的值
    const result = schema.parse(value)
    const outputAge: number = result.age
  },
})

const schema = z.object({
  age: z.string().transform((age) => Number(age)),
})

// Tanstack Form 使用标准模式的输入类型
const defaultValues: z.input<typeof schema> = {
  age: '13',
}

const form = useForm({
  defaultValues,
  validators: {
    onChange: schema,
  },
  onSubmit: ({ value }) => {
    const inputAge: string = value.age
    // 通过模式解析获取转换后的值
    const result = schema.parse(value)
    const outputAge: number = result.age
  },
})

向提交处理传递额外数据

使用标准模式转换数据

Subscribe to Bytes

Subscribe to Bytes