Skip to content

@agala-labs/ui

Input

Captures a single line of text with optional icons and validation.

Examples

Default
<AgalaInput v-model="email" type="email" icon-start="mail" placeholder="you@example.com" />

Import

import { AgalaInput } from '@agala-labs/ui'

API

PropTypeDefaultDescription
modelValuestring—Value used by v-model.
size'sm' | 'md' | 'lg''md'Control size.
variant'default' | 'ghost''default'Visual treatment.
typestring'text'Native input type.
placeholderstring—Placeholder text.
iconStart / iconEndstring—Agala icon names.
iconEndActionablebooleanfalseMakes the trailing icon interactive.
errorbooleanfalseSets invalid styling.
errorMessagestring—Inline error copy.
disabled / readonlybooleanfalseNative input states.
id / inputIdstring—ID bound to the native input; inputId is the legacy alias.
namestring—Native form field name.
requiredbooleanfalseNative required state.
autocompletestring—Native autocomplete token.
ariaLabel / ariaLabelledbystring—Accessible name or referenced label id.
ariaDescribedby / ariaDetails / ariaErrorMessagestring—Accessible supporting and validation references.
ariaInvalid / ariaRequiredboolean | string—Explicit ARIA validation state.
classstring—Class applied to the native input.
wrapperClassstring—Class applied to the outer input wrapper.

Events

  • update:modelValue(value: string)
  • icon-end-click

Accessibility

For a visible label, pair with FormField. Form and ARIA attributes bind to the native input, never the wrapper; inputId remains a backwards-compatible alias for id.

Released under the MIT License.