@umbraco/headless-forms-react/types.d.ts

Umbraco Forms React Components for Umbraco Heartcore

import { CSSProperties } from 'react';
export interface FormConditionRule {
    field: string;
    operator: FormConditionRuleOperatorType;
    value: string;
}
export declare enum FormConditionRuleOperatorType {
    Is = "IS",
    IsNot = "IS_NOT",
    GreaterThen = "GREATER_THEN",
    LessThen = "LESS_THEN",
    Contains = "CONTAINS",
    StartsWith = "STARTS_WITH",
    EndsWith = "ENDS_WITH"
}
export interface FormCondition {
    actionType: FormConditionActionType;
    logicType: FormConditionLogicType;
    rules: FormConditionRule[];
}
export declare enum FormConditionLogicType {
    All = "ALL",
    Any = "ANY"
}
export declare enum FormConditionActionType {
    Show = "SHOW",
    Hide = "HIDE"
}
export interface FormField {
    caption: string;
    alias: string;
    required: boolean;
    requiredErrorMessage?: string;
    settings: object;
    type: string;
    preValues?: [];
    helpText?: string;
    condition?: FormCondition;
}
export interface FormColumn {
    width: number;
    fields: FormField[];
    caption?: string;
}
export interface FormFieldset {
    columns: FormColumn[];
    caption?: string;
    condition?: FormCondition;
}
export interface FormPage {
    fieldsets: FormFieldset[];
    caption?: string;
}
export interface Form {
    _id: string;
    indicator?: string;
    name?: string;
    nextLabel?: string;
    previousLabel?: string;
    submitLabel?: string;
    disableDefaultStylesheet: boolean;
    fieldIndicationType: FormFieldIndicationType;
    hideFieldValidation: boolean;
    messageOnSubmit?: string;
    showValidationSummary: boolean;
    pages: FormPage[];
}
export declare enum FormFieldIndicationType {
    NoIndicator = "NO_INDICATOR",
    MarkMandatoryFields = "MARK_MANDATORY_FIELDS",
    MarkOptionalFields = "MARK_OPTIONAL_FIELDS"
}
export interface FieldProps {
    alias: string;
    caption: string;
    condition?: FormCondition;
    helpText?: string;
    requiredErrorMessage?: string;
}
export interface Errors {
    [key: string]: string[];
}
export declare type FieldValue = string | string[] | null | undefined;
export interface Field {
    name: string;
    ref?: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | HTMLInputElement[] | null[];
    parseValue?: Function;
    validate?: (value?: FieldValue) => string[] | undefined;
}
export interface FormData {
    [key: string]: FieldValue;
}
export interface FormContext {
    data: FormData;
    errors: Errors;
    form: Form;
    recaptchaPublicKey?: string;
    registerField: (field: Field) => void;
    unregisterField: (name: string) => void;
    onValueChange: (alias: string, value?: FieldValue) => void;
}
export interface Theme {
    form: string | CSSProperties;
    page: string | CSSProperties;
    fieldset: string | CSSProperties;
    column: string | CSSProperties;
    fieldGroup: string | CSSProperties;
}
export declare type ThemeContext = Theme;
export declare type Element = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | HTMLInputElement[];