Registry and Configuration ​

The registry stores global rules, formats, locale messages, and the message template engine. Registered capabilities are shared within the current JavaScript runtime and are suitable for reuse across fields and forms.

Register custom rules ​

Use registerValidateRules() to register validation functions keyed by rule name:

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

registerValidateRules({
  usernameAvailable(value) {
    if (!value)
      return ''
    return value === 'silver' ? '' : 'Username is already taken'
  },
})

After registration, declare the rule on a Formily field:

<Field
  name="username"
  :validator="{ usernameAvailable: true }"
/>

The object key selects the registered function. Its configured value remains available on the current rule object and validation context:

import { validate } from '@silver-formily/validator'

await validate('formily', {
  usernameAvailable: true,
})

Registering the same rule name again replaces the previous function.

Register custom formats ​

registerValidateFormats() accepts strings, regular expressions, and functions that return booleans:

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

registerValidateFormats({
  slug: /^[a-z0-9-]+$/,
  internalCode: value => typeof value === 'string' && value.startsWith('SF-'),
})

Reference a format through the string shorthand or a rule object:

<Field name="slug" validator="slug" />

<Field
  name="code"
  :validator="{ format: 'internalCode' }"
/>

import { validate } from '@silver-formily/validator'

await validate('silver-formily', 'slug')
await validate('SF-001', { format: 'internalCode' })

Registered strings are converted to RegExp objects internally.

Configure locale messages ​

Register messages ​

registerValidateLocale() merges messages incrementally by language identifier:

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

registerValidateLocale({
  'en-US': {
    usernameAvailable: 'Username is already taken',
    slug: 'Only lowercase letters, numbers, and hyphens are allowed',
  },
})

Registering the same language again only replaces the supplied message paths; other messages remain intact.

Switch language ​

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

setValidateLanguage('en-US')

Language lookup first checks for an exact registered identifier. Without an exact result, it returns the first identifier whose lowercase form has a containment relationship with the requested value. For example, among the built-in locales, EN matches en and US matches en-US. If no match is found, the current language identifier is preserved.

Built-in languages ​

Module initialization registers these language identifiers:

• en
• en-US
• zh
• zh-CN
• zh-TW
• ja

Built-in messages cover common rules and formats such as required, min, max, email, url, and phone. Custom messages can extend or replace them incrementally.

Customize message templates ​

The default renderer supports {{path.to.value}} path placeholders. Register a preprocessing template engine to add custom syntax:

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

registerValidateMessageTemplateEngine((message, context) => {
  return String(message).replace('$title', context.title)
})

The custom engine runs first, and its output then goes through built-in {{...}} path replacement. The two mechanisms can therefore be combined.

Read current configuration ​

The query APIs are primarily useful for debugging, framework adapters, and tests:

import {
  getLocaleByPath,
  getValidateFormats,
  getValidateLanguage,
  getValidateLocale,
  getValidateLocaleIOSCode,
  getValidateMessageTemplateEngine,
  getValidateRules,
} from '@silver-formily/validator'

getValidateLanguage()
getValidateLocale('required')
getLocaleByPath('required', 'en-US')
getValidateLocaleIOSCode('en')
getValidateFormats('email')
getValidateRules('required')
getValidateMessageTemplateEngine()