FormEffectHooks ​

Form-level side-effect hooks for subscribing to Form lifecycle events

Description ​

FormEffectHooks are used inside the Form effects function to listen for form-level lifecycle events. Each hook corresponds to a lifecycle type in LifeCycleTypes.

All Form Effect Hooks ​

Lifecycle ​

Value Changes ​

Submit ​

Submit Validation ​

Validation ​

Other ​

Usage ​

All form hooks follow a uniform signature:

onFormXxx(callback: (form: Form) => void): void

Basic Usage ​

import { createForm, onFormMount, onFormSubmit } from '@silver-formily/core'

const form = createForm({
  effects() {
    onFormMount((form) => {
      console.log('Form mounted')
    })

    onFormSubmit((form) => {
      console.log('Submitting:', form.values)
    })
  },
})

onFormReact ​

A special reactive side-effect that auto-tracks form state changes:

onFormReact((form) => {
  // Auto-tracks all observable properties read from form
  console.log(form.values, form.valid)
})

Equivalent to onFormInit + autorun.