Interface

VPFieldOptions

VPFieldOptions

A partial interface which can be passed into any VPField constructor to be initialized as a FieldOption instance with standard defaults applied

View Source interfaces/VPOptions.ts, line 131

Extends

Members

Array

# CustomRules Optional

Custom Validation rules to apply

View Source interfaces/VPOptions.ts, line 170

ChangeActions

# DirtyOn Optional

Input events required to consider input state as dirty

View Source interfaces/VPOptions.ts, line 145

string

# ErrorClassName Optional

Classname appended when validation is erroneous

Inherited From:

View Source interfaces/VPOptions.ts, line 28

boolean

# ForceRules Optional

Force DOM rules to supersede option rules

View Source interfaces/VPOptions.ts, line 160

ChangeActions

# FormatOn Optional

Input events required to trigger formatters for inputs

View Source interfaces/VPOptions.ts, line 150

InputFormatters

# InputFormatter Optional

Formatters to apply according to FormatOn rules

View Source interfaces/VPOptions.ts, line 175

HTMLValidationRules

# InputRules Optional

Standard HTML Validation rules to apply

View Source interfaces/VPOptions.ts, line 165

Array

# InputTypes Optional

The types of inputs we look for when parsing for inputs

View Source interfaces/VPOptions.ts, line 205

ValidationLifecycle.<T>

# Lifecycle Optional

Lifecycle bindings to perform on Valid or Invalid states

Inherited From:

View Source interfaces/VPOptions.ts, line 23

HTMLElement | null

# MessageAnchor Optional

An anchor point for message nodes. Will default to the internal element if undefined

Inherited From:

View Source interfaces/VPOptions.ts, line 48

string

# MessageClassName Optional

Classname message nodes will bear

Inherited From:

View Source interfaces/VPOptions.ts, line 38

string

# MessageContainerClassName Optional

Classname message node container will bear

Inherited From:

View Source interfaces/VPOptions.ts, line 43

VerticalPosition

# MessagePOS Optional

Message positioning; Determines how the messaging container is mounted to the anchor point

Inherited From:

View Source interfaces/VPOptions.ts, line 53

boolean

# Notify Optional

Notify parent of changes, validating siblings together

View Source interfaces/VPOptions.ts, line 140

null | ValidInput

# PrimaryInput Optional

The input we will validate against

View Source interfaces/VPOptions.ts, line 190

number

# PrimaryInputIndex Optional

The index to pluck from if we find multiple eligible inputs to parse

View Source interfaces/VPOptions.ts, line 195

null | string

# PrimaryInputType Optional

The type of input we should prioritize picking from if multiple eligible inputs of different types are found

View Source interfaces/VPOptions.ts, line 200

HTMLElement | null

# ScrollAnchor Optional

An anchor point to scroll to if scrolling is enabled and an instance is erroneous

Inherited From:

View Source interfaces/VPOptions.ts, line 63

ScrollIntoViewOptions | boolean

# ScrollOptions Optional

Standard ScrollItnoViewOptions, see MDN

Inherited From:

View Source interfaces/VPOptions.ts, line 68

boolean

# ScrollTo Optional

Indicates if we should scroll to the instance on failed validation

Inherited From:

View Source interfaces/VPOptions.ts, line 58

boolean

# ShowCustomRuleErrors Optional

Show custom validation error messages

View Source interfaces/VPOptions.ts, line 215

boolean

# ShowFieldRuleErrors Optional

Show standard HTML5 validation error messages

View Source interfaces/VPOptions.ts, line 210

boolean

# ValidateAsync Optional

Force IsValid to always resolve async, regardless of the presence of promises

View Source interfaces/VPOptions.ts, line 180

boolean

# ValidateAsyncResolved Optional

Force waiting for async validation to finish before being able to validate again

View Source interfaces/VPOptions.ts, line 185

boolean

# ValidateLazyCustomRules Optional

Validate custom rules lazily

View Source interfaces/VPOptions.ts, line 225

boolean

# ValidateLazyFieldRules Optional

Validate HTML validation rules lazily

View Source interfaces/VPOptions.ts, line 220

ChangeActions

# ValidateOn Optional

Input events required to trigger validation for inputs

View Source interfaces/VPOptions.ts, line 155

string

# ValidClassName Optional

Classname appended when validation is successful

Inherited From:

View Source interfaces/VPOptions.ts, line 33