New to Kendo UI for VueStart a free 30-day trial

InputProps

Interface

Represents the props of the KendoVue Input component. Extends the native input props.

Definition

Package:@progress/kendo-vue-inputs

Properties

Identifies the element(s) which will label the component.

Defines a string value that labels an interactive element.

Defines a string value that labels an interactive element.

defaultValue?

string | number | string[]

dir?

string

disabled?

boolean

fillMode?

"flat" | "solid" | "outline"

Configures the fillMode of the Input.

The available options are:

  • solid
  • outline
  • flat
Default:

undefined

iconName?

string

Defines a string prop that controls the input icon.

id?

string

Renders a floating label for the Input component.

Defines additional class to the input element.

inputPrefix?

string | boolean | object | Function

Defines if the inputPrefix will be shown. Accepts a slot name, a render function, or a Vue component.

inputSuffix?

string | boolean | object | Function

Defines if the inputSuffix will be shown. Accepts a slot name, a render function, or a Vue component.

label?

string

Defines the built-in maxlength property of the text inputs.

  • As the property is directly passed to the internal input element, when defining it, it should be written as it is - maxlength. Camel-case and kebap-case won't work in this scenario.

Defines the built-in minlength property of the text inputs.

  • As the property is directly passed to the internal input element, when defining it, it should be written as it is - minlength. Camel-case and kebap-case won't work in this scenario.

modelValue?

string | number

name?

string

Specifies the name property of the input DOM element.

onBlur?

(event: any) => void

Fires when the input is blurred.

Parameters:eventany

onChange?

(event: any) => void

Fires when the change event of the input is triggered.

Parameters:eventany

onFocus?

(event: any) => void

Fires when the input is focused.

Parameters:eventany

onInput?

(event: any) => void

Fires when the input event of the input is triggered.

Parameters:eventany

onKeydown?

(event: any) => void

Fires when the 'keydown' input event is triggered.

Parameters:eventany

onKeypress?

(event: any) => void

Fires when the 'keypress' input event is triggered.

Parameters:eventany

onKeyup?

(event: any) => void

Fires when the 'keyup' input event is triggered.

Parameters:eventany

Specifies the placeholder of an input element. Used to define if the input is empty.

required?

boolean

Specifies if null is a valid value for the component.

rounded?

"small" | "medium" | "large" | "none" | "full"

Configures the roundness of the Input.

The available options are:

  • none
  • small
  • medium
  • large
  • full
Default:

undefined

Defines a boolean prop that controls whether to show the clear icon. Defaults to 'false'.

Defines a boolean prop that controls whether to show the loading icon. Defaults to 'false'.

Defines a boolean prop that controls whether to show the validation icon. Defaults to 'false'.

size?

"small" | "medium" | "large"

Configures the size of the Input.

The available options are:

  • small
  • medium
  • large
Default:

undefined

tabIndex?

number

Defines tabindex to the input element.

valid?

boolean

Overrides the validity state of the component. If valid is set, the required property will be ignored.

validate?

boolean

Controls the form error message of the component. If set to an empty string, no error will be thrown.

If set to false, no visual representation of the invalid state of the component will be applied.

value?

string | number | string[]

Defines additional class to the wrapper element.