LifeCycle ​

LifeCycle maps one or more event types to handlers that Heart calls when events are published. Application code normally creates listeners through Form Effect Hooks and Field Effect Hooks.

Constructor ​

type LifeCycleHandler<Payload> = (payload: Payload, context: any) => void

interface LifeCycleConstructor {
  new<Payload>(type: string, handler: LifeCycleHandler<Payload>): LifeCycle<Payload>
  new<Payload>(listeners: Record<string, LifeCycleHandler<Payload>>): LifeCycle<Payload>
}

One instance may receive multiple event-type and handler pairs.

notify ​

Runs a handler only when the supplied type matches an event type registered in the constructor.

interface notify {
  <Payload>(type: string, payload?: Payload, context?: any): void
}

LifeCycleTypes ​

LifeCycleTypes is the public lifecycle event enum exported by Core. Events are grouped into:

• Form events: initialization, mounting, value changes, input, validation, submission, reset, graph changes, and loading.
• Field events: initialization, mounting, value changes, input, validation, submission, reset, and loading.

import { LifeCycleTypes } from '@silver-formily/core'

LifeCycleTypes.ON_FORM_VALUES_CHANGE // 'onFormValuesChange'
LifeCycleTypes.ON_FORM_SUBMIT // 'onFormSubmit'
LifeCycleTypes.ON_FIELD_VALUE_CHANGE // 'onFieldValueChange'
LifeCycleTypes.ON_FIELD_VALIDATE_END // 'onFieldValidateEnd'

For application-facing events and their hooks, see Form Effect Hooks and Field Effect Hooks.