Skip to content

UnifiedInput

A Vue component.

File: src/components/shared/UnifiedInput.vue

Overview

Props

NameTypeDefaultRequiredDescription
modelValueunionundefinedNo description
typestring'text'No description
placeholderstringundefinedNo description
labelstringundefinedNo description
hintstringundefinedNo description
errorMessagestringundefinedNo description
disabledbooleanundefinedNo description
readonlybooleanundefinedNo description
requiredbooleanundefinedNo description
autocompletestringundefinedNo description
maxLengthnumberundefinedNo description
minLengthnumberundefinedNo description
minunionundefinedNo description
maxunionundefinedNo description
stepunionundefinedNo description
rowsnumberundefinedNo description
colsnumberundefinedNo description
resizebooleanundefinedNo description
sizeunion'md'No description
variantunion'default'No description
prefixIconanyundefinedNo description
suffixIconanyundefinedNo description
clearablebooleanundefinedNo description
clearButtonLabelstring'Clear input'No description
showCharCountbooleanundefinedNo description
passwordTogglebooleanundefinedNo description
idstringundefinedNo description

Props Details

modelValue

No description available.

  • Type: union
  • Required: Yes
  • Default: undefined

type

No description available.

  • Type: string
  • Required: No
  • Default: 'text'

placeholder

No description available.

  • Type: string
  • Required: No
  • Default: undefined

label

No description available.

  • Type: string
  • Required: No
  • Default: undefined

hint

No description available.

  • Type: string
  • Required: No
  • Default: undefined

errorMessage

No description available.

  • Type: string
  • Required: No
  • Default: undefined

disabled

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

readonly

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

required

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

autocomplete

No description available.

  • Type: string
  • Required: No
  • Default: undefined

maxLength

No description available.

  • Type: number
  • Required: No
  • Default: undefined

minLength

No description available.

  • Type: number
  • Required: No
  • Default: undefined

min

No description available.

  • Type: union
  • Required: No
  • Default: undefined

max

No description available.

  • Type: union
  • Required: No
  • Default: undefined

step

No description available.

  • Type: union
  • Required: No
  • Default: undefined

rows

No description available.

  • Type: number
  • Required: No
  • Default: undefined

cols

No description available.

  • Type: number
  • Required: No
  • Default: undefined

resize

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

size

No description available.

  • Type: union
  • Required: No
  • Default: 'md'

variant

No description available.

  • Type: union
  • Required: No
  • Default: 'default'

prefixIcon

No description available.

  • Type: any
  • Required: No
  • Default: undefined

suffixIcon

No description available.

  • Type: any
  • Required: No
  • Default: undefined

clearable

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

clearButtonLabel

No description available.

  • Type: string
  • Required: No
  • Default: 'Clear input'

showCharCount

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

passwordToggle

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

id

No description available.

  • Type: string
  • Required: No
  • Default: undefined

Events

NameParametersDescription
update:modelValueunionNo description
inputEventNo description
changeEventNo description
blurFocusEventNo description
focusFocusEventNo description
keydownKeyboardEventNo description
keypressKeyboardEventNo description
keyupKeyboardEventNo description
clearunknownNo description

Event Details

update:modelValue

No description available.

Parameters: union

input

No description available.

Parameters: Event

change

No description available.

Parameters: Event

blur

No description available.

Parameters: FocusEvent

focus

No description available.

Parameters: FocusEvent

keydown

No description available.

Parameters: KeyboardEvent

keypress

No description available.

Parameters: KeyboardEvent

keyup

No description available.

Parameters: KeyboardEvent

clear

No description available.

Parameters: unknown

Slots

NameScopedDescription
prefixNo description
suffixNo description

Slot Details

prefix

No description available.

Scoped: No

suffix

No description available.

Scoped: No

Methods

This component exposes no public methods.

Usage Example

vue
<template>
  <UnifiedInput
    :modelValue="undefined"
    @update:modelValue="handleUpdate:modelValue"
    @input="handleInput"
    @change="handleChange"
    @blur="handleBlur"
    @focus="handleFocus"
    @keydown="handleKeydown"
    @keypress="handleKeypress"
    @keyup="handleKeyup"
    @clear="handleClear">
    <template #prefix>
      <!-- Slot content for prefix -->
    </template>
    <template #suffix>
      <!-- Slot content for suffix -->
    </template>
  </UnifiedInput>
</template>

<script setup lang="ts">
const handleUpdate:modelValue = (data: union) => {
  // Handle update:modelValue event
}

const handleInput = (data: Event) => {
  // Handle input event
}

const handleChange = (data: Event) => {
  // Handle change event
}

const handleBlur = (data: FocusEvent) => {
  // Handle blur event
}

const handleFocus = (data: FocusEvent) => {
  // Handle focus event
}

const handleKeydown = (data: KeyboardEvent) => {
  // Handle keydown event
}

const handleKeypress = (data: KeyboardEvent) => {
  // Handle keypress event
}

const handleKeyup = (data: KeyboardEvent) => {
  // Handle keyup event
}

const handleClear = (data: unknown) => {
  // Handle clear event
}
</script>

File Location

src/components/shared/UnifiedInput.vue


This documentation was automatically generated from the component source code.

Released under the AGPL-3.0 License.