just-validate/dist/modules/interfaces.d.ts

Modern, simple, lightweight (~5kb gzip) form validation library written in Typescript, with no dependencies (no JQuery!). Support a wide range of predefined rules, async, files, dates validation, custom error messages and styles, localization. Support wri

export type ClassListType = string | string[];
export interface GlobalConfigInterface {
    errorFieldStyle: Partial<CSSStyleDeclaration>;
    errorFieldCssClass: ClassListType;
    errorLabelStyle: Partial<CSSStyleDeclaration>;
    errorLabelCssClass: ClassListType;
    successFieldStyle?: Partial<CSSStyleDeclaration>;
    successFieldCssClass: ClassListType;
    successLabelStyle?: Partial<CSSStyleDeclaration>;
    successLabelCssClass: ClassListType;
    lockForm: boolean;
    testingMode: boolean;
    focusInvalidField?: boolean;
    tooltip?: TooltipConfigInterface;
    errorsContainer?: string | Element | null;
    validateBeforeSubmitting: boolean;
    submitFormAutomatically: boolean;
}
export declare enum Rules {
    Required = "required",
    Email = "email",
    MinLength = "minLength",
    MaxLength = "maxLength",
    Password = "password",
    Number = "number",
    Integer = "integer",
    MaxNumber = "maxNumber",
    MinNumber = "minNumber",
    StrongPassword = "strongPassword",
    CustomRegexp = "customRegexp",
    MinFilesCount = "minFilesCount",
    MaxFilesCount = "maxFilesCount",
    Files = "files"
}
export type TooltipPositionType = 'left' | 'top' | 'right' | 'bottom';
export interface TooltipConfigInterface {
    position: TooltipPositionType;
}
export declare enum GroupRules {
    Required = "required"
}
type ValidatorReturn = boolean | (() => Promise<boolean>);
export interface FileRuleValueInterface {
    extensions?: string[];
    types?: string[];
    minSize?: number;
    maxSize?: number;
    names?: string[];
}
export interface FilesRuleValueInterface {
    files?: FileRuleValueInterface;
}
export type FieldRuleValueType = number | string | RegExp | FilesRuleValueInterface;
export type ValidatorFuncType = (value: string | boolean, context: FieldsInterface) => ValidatorReturn;
export type CustomMessageFuncType = (value: ElemValueType, context: FieldsInterface) => string;
export interface FieldRuleInterface {
    rule?: Rules;
    errorMessage?: string | CustomMessageFuncType;
    validator?: ValidatorFuncType;
    value?: FieldRuleValueType;
    plugin?: (value: string | boolean, context: FieldsInterface) => boolean;
}
export interface GroupRuleInterface {
    rule?: GroupRules;
    errorMessage?: string;
    successMessage?: string;
}
export interface FieldConfigInterface extends Partial<Pick<GlobalConfigInterface, 'errorFieldStyle' | 'errorFieldCssClass' | 'errorLabelStyle' | 'errorLabelCssClass' | 'successFieldStyle' | 'successFieldCssClass' | 'successLabelStyle' | 'successLabelCssClass' | 'tooltip' | 'errorsContainer'>> {
    successMessage?: string | CustomMessageFuncType;
}
export interface FieldInterface {
    rules: FieldRuleInterface[];
    elem: HTMLInputElement;
    isValid?: boolean;
    errorMessage?: string;
    successMessage?: string;
    config?: FieldConfigInterface;
    asyncCheckPending?: boolean;
    touched: boolean;
}
export type GroupFieldType = 'radio' | 'checkbox';
export interface GroupFieldInterface {
    rules: GroupRuleInterface[];
    groupElem: HTMLElement;
    elems: HTMLInputElement[];
    isValid?: boolean;
    touched: boolean;
    errorMessage?: string;
    successMessage?: string;
    config?: FieldConfigInterface;
}
export interface FieldsInterface {
    [field: string]: FieldInterface;
}
export interface GroupFieldsInterface {
    [groupField: string]: GroupFieldInterface;
}
export interface EventListenerInterface {
    type: string;
    elem: HTMLInputElement | Document | HTMLFormElement;
    func: (ev: Event) => void;
}
export interface LocaleDictInterface {
    [localeKey: string]: string;
}
export interface LocaleInterface {
    key: string;
    dict: LocaleDictInterface;
}
export declare enum CustomStyleTagIds {
    Label = "label",
    LabelArrow = "labelArrow"
}
export interface TooltipInstance {
    refresh: () => void;
}
export type ElemValueType = boolean | string | FileList | null;
export interface ShowLabelsInterface {
    [field: string]: string;
}
export type FieldSelectorType = string | HTMLInputElement | HTMLElement;
export interface OnValidateCallbackInterface {
    isValid?: boolean;
    isSubmitted: boolean;
    fields: FieldsInterface;
    groups: GroupFieldsInterface;
}
export {};