Skip to main content

Interface: CustomFieldValidationConfig

Validation rules and constraints for custom fields.

This interface defines the validation requirements that determine what constitutes valid input for a custom field. These rules are applied during form submission to ensure that all provided data meets business and technical requirements before processing.

Properties​

confirmationRequired?​

optional confirmationRequired: boolean

Whether the field requires a confirmation input.

When true, users must enter the value twice to confirm it's correct. This is typically used for critical information like email addresses or passwords where typos could cause significant issues.

decimalPlaces?​

optional decimalPlaces: number

Number of decimal places for numeric fields.

For number fields, specifies how many decimal places are allowed or required. This ensures consistent precision in numerical data like measurements, quantities, or financial figures.

isRequired?​

optional isRequired: boolean

Whether a value must be provided for this field.

When true, the field cannot be left empty during submission. Required fields are typically marked with an asterisk (*) in forms to signal to users that they must be completed.

isTranslatable?​

optional isTranslatable: boolean

Whether this field supports multiple language versions.

When true, the field can store different values for different languages, allowing for localized content. This is particularly useful for descriptive fields that may need to be presented in the user's preferred language.

isUnique?​

optional isUnique: boolean

Whether the value must be unique across submissions.

When true, the system will verify that no other submission has the same value for this field. This is useful for ensuring uniqueness of identifiers, reference numbers, or other values that should not be duplicated.

max?​

optional max: number

Maximum number of characters allowed.

For text-based fields, specifies the maximum length that will be accepted. This prevents overly long inputs that might cause issues in storage or display, or that might indicate user error.

min?​

optional min: number

Minimum number of characters required.

For text-based fields, specifies the minimum length that will be accepted. This helps ensure that inputs like names, addresses, or references contain sufficient information to be useful.

regexExpression?​

optional regexExpression: string

Pattern for validating input format.

A regular expression string that input must match to be considered valid. This allows for precise format validation for inputs like phone numbers, postal codes, or reference numbers that must follow specific patterns.

showOnFrontend?​

optional showOnFrontend: boolean

Whether to display this field in customer-facing interfaces.

When true, this field will be visible in customer-facing interfaces like the checkout form or order summaries. When false, it may only be visible in administrative interfaces.

validationMessage?​

optional validationMessage: string

Custom message to display when validation fails.

A specific error message to show users when their input doesn't meet the validation requirements. A clear, specific message helps users understand what's wrong and how to fix it.