@try-at-software/input-elements/lib/SingleValueInputElements/ISingleInputElementConfiguration.d.ts

A package providing different input elements that are extensible and easily configurable for your custom needs.

import { IInputElementConfiguration } from '../IInputElementConfiguration';
import { ILoadingInputElementConfiguration } from '../ILoadingInputElementConfiguration';
import { IValueComparator } from './Comparators';
export interface ISingleValueInputElementConfiguration<TValue> extends IInputElementConfiguration, ILoadingInputElementConfiguration {
    /**
     * A value indicating whether error messages will be rendered by the underlying input element itself.
     * If it is set to false, no error message will be rendered but the validation pipeline will not be changed at all.
     */
    renderErrors?: boolean;
    /**
     * A value indicating whether the underlying component should render an appropriate indicator if it is required (and if the component itself is capable of doing this).
     * If it is set to false, no required indicator will be rendered but the validation pipeline will not be changed at all.
     */
    renderRequiredIndicator?: boolean;
    /**
     * A value indicating whether the input element should be validated even if it is not required and empty.
     */
    executeAllValidations?: boolean;
    /**
     * A function that should be executed before every validation.
     * If it returns false, no validation rule will be executed.
     */
    shouldExecuteValidation?: () => boolean;
    /**
     * An object used to override the default comparing mechanism for computing the `hasChanges` value.
     * This may be useful when a single input element is used to provide multiple values. The `===` operator will not work well with array so it should be overridden.
     */
    comparator?: IValueComparator<TValue>;
}