Sign in
Use password manager autocomplete while allowing temporary visibility.
Components / Forms
A native password field with a localized visibility toggle.
Last changed in version 0.14.2: Improve keyboard navigation, action feedback, and selected colors across Vue components.
bunx --bun @getweini/cli@latest add password-inputImport the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.
<script setup lang="ts">
import { ref } from 'vue'
import PasswordInput from './components/ui/password-input/PasswordInput.vue'
const password = ref('')
const messages = { showPassword: 'Show password', hidePassword: 'Hide password' }
</script>
<template>
<label for="account-password">Password</label>
<PasswordInput
id="account-password"
v-model="password"
name="password"
autocomplete="current-password"
:messages="messages"
/>
</template>The native input handles validation, autocomplete, focus, and form submission. The trailing button changes visibility without moving focus. Connect your help and error text with aria-describedby.
Use password manager autocomplete while allowing temporary visibility.
Show application-owned password guidance beside a new-password field.
The visibility button keeps focus in the field.
<script setup lang="ts">
import { ref } from 'vue'
import PasswordInput from './components/ui/password-input/PasswordInput.vue'
const password = ref('')
const messages = { showPassword: 'Show password', hidePassword: 'Hide password' }
</script>
<template>
<label for="password">Password</label>
<PasswordInput
id="password"
v-model="password"
name="password"
autocomplete="current-password"
:messages="messages"
required
/>
</template>The application supplies its own password rules.
<script setup lang="ts">
import { ref } from 'vue'
import PasswordInput from './components/ui/password-input/PasswordInput.vue'
const password = ref('')
const messages = { showPassword: 'Show password', hidePassword: 'Hide password' }
</script>
<template>
<label for="new-password">New password</label>
<PasswordInput
id="new-password"
v-model="password"
autocomplete="new-password"
:messages="messages"
aria-describedby="password-help"
required
/>
<p id="password-help">Use at least 12 characters.</p>
</template>Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.
| Name | Type or signature | Default | What it does |
|---|---|---|---|
rootClassprop | ClassValue | Not set | Classes applied to the outer component wrapper. |
rootStyleprop | StyleValue | Not set | Styles applied to the outer component wrapper. |
idprop | string | undefined | Not set | Give the control an ID so a label or description can refer to it. |
sizeprop | ControlSize | undefined | "md" | Choose the visual size. Medium is the usual default where available. |
invalidprop | boolean | undefined | Not set | Show the invalid state; also provide a visible error message. |
disabledprop | boolean | undefined | Not set | Prevent interaction and show the disabled state. |
readonlyprop | boolean | undefined | Not set | Show the value while preventing edits. |
defaultVisibleprop | boolean | undefined | false | Starting visibility when the parent does not control it. |
messagesprop | PasswordInputMessages | Required | Supply the text this component displays for its built-in actions and states. |
modelValuemodel | string | undefined | Not set | Current value. Use v-model to keep it in sync with your page. |
modelModifiersprop | Partial<Record<"trim" | "lazy", true>> | undefined | Not set | Controls the model modifiers behavior of PasswordInput. |
update:modelValueevent | [value: string | undefined] | — | Requests a new model value from the parent. |
errorslot | { message: string; messages: string[]; } | Optional | Content for the error area of PasswordInput. |
elementexposed | HTMLInputElement | null | — | Reference to the underlying HTML element. |
focusexposed | () => void | undefined | — | Move keyboard focus to this control. |
hideexposed | () => void | — | Access hide from a component template ref. |
showexposed | () => void | — | Access show from a component template ref. |
// packages/frameworks/vue/components/password-input/types.ts
// ------- IMPORTS -------
import type { ControlSize } from '@getweini/vue/types'
import type { HTMLAttributes } from 'vue'
// ------- TYPES -------
export interface PasswordInputMessages {
showPassword: string
hidePassword: string
}
export interface PasswordInputProps {
rootClass?: HTMLAttributes['class']
rootStyle?: HTMLAttributes['style']
id?: string
size?: ControlSize
invalid?: boolean
disabled?: boolean
readonly?: boolean
defaultVisible?: boolean
messages: PasswordInputMessages
}
// packages/frameworks/vue/dist/types/index.d.ts
export type { ButtonOptions, ButtonProps } from './button';
export type ControlSize = 'sm' | 'md' | 'lg';
export interface SelectOption<T = unknown> {
label: string;
value: T;
disabled?: boolean;
}
/** Application-owned copy. Bind translated strings reactively when the locale changes. */
export interface ListboxMessages {
/** Popup name when no aria-label or aria-labelledby is supplied. */
listboxLabel: string;
empty: string;
clearSelection: string;
}
export interface ListboxProps<T> {
options: readonly SelectOption<T>[];
messages: ListboxMessages;
id?: string;
disabled?: boolean;
required?: boolean;
invalid?: boolean;
name?: string;
form?: string;
placeholder?: string;
size?: ControlSize;
clearable?: boolean;
gap?: number;
/** Supply stable equality for object values. Values must be unique. */
by?: (a: T, b: T) => boolean;
/** Required for meaningful form submission of object values. */
serialize?: (value: T) => string;
}
// packages/frameworks/vue/dist/types/button.d.ts
import type { Component } from 'vue';
/** Options shared by button implementations across frameworks. */
export interface ButtonOptions<Variant extends string = string, Size extends string = string> {
variant?: Variant;
size?: Size;
disabled?: boolean;
loading?: boolean;
type?: 'button' | 'submit' | 'reset';
}
/** Vue-specific target options extend the reusable button contract. */
export interface ButtonProps<Variant extends string = 'default' | 'secondary' | 'outline' | 'ghost' | 'destructive', Size extends string = 'sm' | 'md' | 'lg'> extends ButtonOptions<Variant, Size> {
as?: 'button' | 'a' | Component;
asChild?: boolean;
}