Arc.React
    Preparing search index...

    Interface CommandFormContextValue<TCommand>

    interface CommandFormContextValue<TCommand> {
        autoServerValidate: boolean;
        autoServerValidateThrottle: number;
        command: Constructor<TCommand>;
        commandInstance: TCommand;
        commandResult?: any;
        commandVersion: number;
        customFieldErrors: Record<string, string>;
        errorClassName?: string;
        errorDisplayComponent?: ComponentType<ErrorDisplayProps>;
        fieldContainerComponent?: ComponentType<FieldContainerProps>;
        fieldDecoratorComponent?: ComponentType<FieldDecoratorProps>;
        getFieldError: (propertyName: string) => string | undefined;
        iconAddonClassName?: string;
        isAuthorized: boolean;
        isValid: boolean;
        onBeforeExecute?: BeforeExecuteCallback<TCommand>;
        onExecute?: () => Promise<ICommandResult<unknown>>;
        onFieldChange?: (
            command: TCommand,
            fieldName: string,
            oldValue: unknown,
            newValue: unknown,
            validationInfo?: FieldValidationInfo,
        ) => void;
        onFieldValidate?: (
            command: TCommand,
            fieldName: string,
            oldValue: unknown,
            newValue: unknown,
        ) => string | undefined;
        setCommandResult: (result: ICommandResult<unknown>) => void;
        setCommandValues: SetCommandValues<TCommand>;
        setCustomFieldError: (fieldName: string, error: string | undefined) => void;
        setSilentValidationResult: (result: ICommandResult<unknown>) => void;
        showErrors: boolean;
        showTitles: boolean;
        tooltipComponent?: ComponentType<TooltipWrapperProps>;
        validateAllFieldsOnChange: boolean;
        validateOn: "blur" | "change" | "both";
        validateOnInit: boolean;
    }

    Type Parameters

    • TCommand
    Index

    Properties

    autoServerValidate: boolean
    autoServerValidateThrottle: number
    command: Constructor<TCommand>
    commandInstance: TCommand
    commandResult?: any
    commandVersion: number
    customFieldErrors: Record<string, string>
    errorClassName?: string
    errorDisplayComponent?: ComponentType<ErrorDisplayProps>
    fieldContainerComponent?: ComponentType<FieldContainerProps>
    fieldDecoratorComponent?: ComponentType<FieldDecoratorProps>
    getFieldError: (propertyName: string) => string | undefined
    iconAddonClassName?: string
    isAuthorized: boolean
    isValid: boolean
    onBeforeExecute?: BeforeExecuteCallback<TCommand>
    onExecute?: () => Promise<ICommandResult<unknown>>
    onFieldChange?: (
        command: TCommand,
        fieldName: string,
        oldValue: unknown,
        newValue: unknown,
        validationInfo?: FieldValidationInfo,
    ) => void
    onFieldValidate?: (
        command: TCommand,
        fieldName: string,
        oldValue: unknown,
        newValue: unknown,
    ) => string | undefined
    setCommandResult: (result: ICommandResult<unknown>) => void
    setCommandValues: SetCommandValues<TCommand>
    setCustomFieldError: (fieldName: string, error: string | undefined) => void
    setSilentValidationResult: (result: ICommandResult<unknown>) => void
    showErrors: boolean
    showTitles: boolean
    tooltipComponent?: ComponentType<TooltipWrapperProps>
    validateAllFieldsOnChange: boolean
    validateOn: "blur" | "change" | "both"
    validateOnInit: boolean