@progress/kendo-vue-common
Version:
Kendo UI for Vue Common Utilities package
92 lines (91 loc) • 3.1 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
/**
* Represents the basic props of the KendoVue form components.
* @hidden
*
* For runnable examples on forms support, refer to the documentation of the respective form component:
* * [DateInput]({% slug forms_dateinput %})
* * [DatePicker]({% slug forms_datepicker %})
* * [TimePicker]({% slug forms_timepicker %})
* * [DateTimePicker]({% slug forms_datetimepicker %})
* * [AutoComplete]({% slug forms_autocomplete %})
* * [ComboBox]({% slug forms_combobox %})
* * [DropDownList]({% slug forms_dropdownlist %})
* * [MultiSelect]({% slug forms_multiselect %})
* * [Input]({% slug forms_input %})
* * [MaskedTextBox]({% slug forms_maskedtextbox %})
* * [NumericTextBox]({% slug forms_numerictextbox %})
*/
export interface FormComponentProps {
/**
* Controls the form error message of the component. If set to an empty string, no error will be thrown.
*
*/
validationMessage?: string;
/**
* Specifies if `null` is a valid value for the component.
*
*/
required?: boolean;
/**
* Specifies the `name` property of the `input` DOM element.
*
*/
name?: string;
/**
* Overrides the validity state of the component.
* If `valid` is set, the `required` property will be ignored.
*
*/
valid?: boolean;
/**
* If set to `false`, no visual representation of the invalid state of the component will be applied.
*
*/
validityStyles?: boolean;
/**
* @hidden
*/
value?: any;
/**
* @hidden
*/
defaultValue?: any;
}
/**
* Represents the `validity` state of the KendoVue form components.
*
* For runnable examples on forms support, refer to the documentation of the respective form component:
* * [DateInput]({% slug forms_dateinput %})
* * [DatePicker]({% slug forms_datepicker %})
* * [TimePicker]({% slug forms_timepicker %})
* * [DateTimePicker]({% slug forms_timepicker %})
* * [AutoComplete]({% slug forms_autocomplete %})
* * [ComboBox]({% slug forms_combobox %})
* * [DropDownList]({% slug forms_dropdownlist %})
* * [MultiSelect]({% slug forms_multiselect %})
* * [Input]({% slug forms_input %})
* * [MaskedTextBox]({% slug forms_maskedtextbox %})
* * [NumericTextBox]({% slug forms_numerictextbox %})
*
* @hidden
*/
export interface FormComponentValidity {
readonly badInput?: boolean;
readonly customError: boolean;
readonly patternMismatch?: boolean;
readonly rangeOverflow?: boolean;
readonly rangeUnderflow?: boolean;
readonly stepMismatch?: boolean;
readonly tooLong?: boolean;
readonly tooShort?: boolean;
readonly typeMismatch?: boolean;
readonly valid: boolean;
readonly valueMissing: boolean;
}