np-form Imperative Methods

After getting the form instance via ref, you can imperatively call submit, reset, and validateFields.

• submit: trigger form submission manually. Behaves like the submit button — validates first, then runs onSubmit.
• reset: trigger form reset manually. Behaves like the reset button — clears validation and runs onReset.
• validateFields: validate the specified fields by name.

浏览器不支持，请手动复制 imperative.en.vue

<template>
  <div>
    {{ data }}
    <n-space style="margin: 12px 0">
      <n-button @click="onSubmit">Submit</n-button>
      <n-button @click="onValidateAge">Validate Age</n-button>
      <n-button @click="onValidateInfo">Validate Info</n-button>
    </n-space>
    <np-form ref="formRef" v-model="data" :option="option" />
  </div>
</template>
<script setup lang="ts">
import type { FormOption, FormInst } from 'naive-plus'
import { NButton, NSpace, useMessage } from 'naive-ui'
import { ref } from 'vue'

type User = {
  fullName?: string
  tel?: number
  age?: number
  ageMax: number
}

const data = ref<User>({ ageMax: 50 })
const formRef = ref<FormInst>()
const message = useMessage()

const onSubmit = () => {
  formRef.value?.submit()
}

const onValidateAge = () => {
  formRef.value?.validateFields('age').then(() => {
    message.success('Age validated')
  })
}

const onValidateInfo = () => {
  formRef.value?.validateFields(['fullName', 'tel']).then(() => {
    message.success('Name / phone validated')
  })
}

const option: FormOption<User> = {
  onSubmit: async form => {
    console.log('Submitted', form)
    await new Promise<void>(resolve => setTimeout(() => resolve(), 1200))
  },
  columns: [
    {
      label: 'Name',
      key: 'fullName',
      rule: [
        { required: true, message: 'Name is required', trigger: ['blur'] },
      ],
    },
    {
      label: 'Phone',
      key: 'tel',
      type: 'number',
      rule: {
        required: true,
        message: 'Phone is required',
        trigger: ['change'],
      },
    },
    {
      label: 'Max Age',
      key: 'ageMax',
      type: 'number',
      defaultValue: 50,
      rule: {
        required: true,
        message: 'Max age is required',
        trigger: ['change'],
      },
    },
    {
      label: 'Age',
      key: 'age',
      type: 'number',
      // supports dynamic rules, e.g. validating against other fields
      rule: formData => {
        return [
          {
            required: true,
            message: 'Age is required',
            trigger: ['change'],
          },
          {
            validator: (value: number) => value >= 0,
            message: 'Age must be a positive number',
            trigger: ['change'],
          },
          {
            validator: (value: number) => value <= formData.ageMax,
            message: `Age cannot exceed ${formData.ageMax}`,
            trigger: ['change'],
          },
        ]
      },
    },
  ],
}
</script>

Component Configuration

FormInst methods

Method	Description	Type
submit	Submit the form manually	() => Promise<void>
reset	Reset the form manually	() => Promise<void>
validateFields	Validate the given fields	(fields: string | string[]) => Promise<void>