Password Input

Installation

Copy editable source into an initialized application:

pnpm dlx @simurgh-ui/cli add password-input

For package consumption, import from the component subpath and load its optional recipe CSS:

React

import { PasswordInput } from '@simurgh-ui/react/password-input';
import '@simurgh-ui/styles/password-input.css';

Vue

import { PasswordInput } from '@simurgh-ui/vue/password-input';
import '@simurgh-ui/styles/password-input.css';

Angular

import { PasswordInputComponent } from '@simurgh-ui/angular/password-input';
import '@simurgh-ui/styles/password-input.css';

Omit the component stylesheet for fully headless styling. CLI-copied components use the local path written to simurgh.json and the copied application styles instead of these package imports.

Purpose

Password Input preserves one native form control while switching its visual type between password and text. The toggle names its current action, exposes pressed state, and references the controlled input.

Default presentation: styled

The optional component stylesheet provides a complete default recipe, including visual hierarchy and interaction states. Consumers can override semantic tokens or omit the recipe.

Basic usage

Live component Password Input ◆

Account password

Show

Anatomy

The public component parts are listed in API surface below. Use only the parts needed by the example; compound components depend on their documented parent/child nesting.

State model

Controlled state remains the application’s source of truth and must be updated from every change event. Uncontrolled state reads its default only when the component mounts. Do not pass both forms of the same state at once.

Framework	Exact state contract and reset behavior
React	No public controlled/uncontrolled state pair is exposed.
Vue	Controlled: v-model (modelValue + update:modelValue). Uncontrolled: defaultValue. Reset the model ref to its initial value; reset uncontrolled state with a changed Vue :key.
Angular	Controlled two-way binding: [(value)] (value + valueChange). Angular exposes no separate default input; initialize and reset the bound class field explicitly.

Vue

<script setup lang="ts">
import { ref } from 'vue';
const initial = '';
const state = ref(initial);
const resetKey = ref(0);
</script>

<PasswordInput v-model="state">…</PasswordInput>
<button @click="state = initial">Reset controlled</button>
<PasswordInput :key="resetKey" :defaultValue="initial">…</PasswordInput>
<button @click="resetKey++">Reset uncontrolled</button>

Angular

initial = '';
value = this.initial;
reset() { this.value = this.initial; }

<simurgh-password-input [(value)]="value">…</simurgh-password-input>
<button type="button" (click)="reset()">Reset</button>

Prefer a visible external label when layout permits. Use autocomplete="current-password" for sign-in and autocomplete="new-password" for account creation. Revealing changes only presentation; it does not copy, clear, or replace the input value.

Examples

React

<PasswordInput
  aria-label="Account password"
  name="password"
  autoComplete="current-password"
  value={password}
  onChange={(event) => setPassword(event.target.value)}
/>

Vue

<PasswordInput
  v-model="password"
  aria-label="Account password"
  name="password"
  autocomplete="current-password"
/>

Angular

<simurgh-password-input
  [(value)]="password"
  aria-label="Account password"
  name="password"
  autocomplete="current-password"
/>

Accessibility

Preserve the documented composition and accessible names when wrapping or restyling this component. See accessibility and RTL guidance for keyboard, focus, labeling, and directionality requirements.

API surface

• React exports: PasswordInput
• Vue exports: PasswordInput
• Angular exports: PasswordInputComponent

Import these public symbols from the component subpath shown in Installation. Framework-specific props, events, slots, directives, methods, defaults, and native-attribute behavior belong in the API tables on this page; use the linked source only to verify the current implementation.

React API reference

React

An inherited-attributes entry means the component accepts the complete named React native interface, including its event handlers and ARIA and data attributes. Remaining attributes are forwarded to the rendered element unless the component behavior described on this page overrides them.

PasswordInput

Inherited attributes: InputHTMLAttributes<HTMLInputElement> & RefAttributes<HTMLInputElement>.

Prop	Type	Default / requirement
children	ReactNode	undefined
concealLabel	string	'Hide password'
ref	Ref<HTMLInputElement> | undefined	undefined
revealLabel	string	'Show password'

Vue API reference

Vue

Boolean props without explicit defaults use Vue’s false default. Undeclared attributes follow the fallthrough behavior stated for each component.

PasswordInput

Automatic fallthrough is disabled; attrs are manually forwarded to the rendered root.

Prop	Type	Default / requirement
modelValue	string	undefined
defaultValue	string	''
disabled	boolean	false
readonly	boolean	false
revealLabel	string	'Show password'
concealLabel	string	'Hide password'

Event	Payload
update:modelValue	string

Slots: none.

Exposed methods: none.

Angular API reference

Angular

Inputs and outputs use their public template names. Public methods are callable through a template reference or ViewChild. Native attributes apply to the documented template root or directive host; they are not automatically forwarded through component hosts.

PasswordInputComponent

Component selector: simurgh-password-input. The template’s first native element is div.

Input	Type	Default / requirement
inputId	string	createId('password')
aria-label	string	'Password'
value	string	''
name	string	undefined
autocomplete	string	'current-password'
placeholder	string	undefined
disabled	boolean	false
readonly	boolean	false
required	boolean	false
revealLabel	string	'Show password'
concealLabel	string	'Hide password'

Output	Payload
valueChange	string

Content projection: none.

Public method
onInput(event: Event): void

Composition contract

Follow the framework example as a structural contract. Root components own shared state; parts that consume that state must stay under the root (or be attached to projected descendants in Angular). Parts described as conditional are optional until their corresponding interaction or semantic region is used. Do not render a state-consuming part by itself.

Framework	Required parent/child relationship	Conditional parts	Supporting types
React	PasswordInput is standalone and required when using this component.	Content is optional unless the API requires a label or value.	None.
Vue	PasswordInput is standalone and required when using this component.	Content is optional unless the API requires a label or value.	None.
Angular	PasswordInputComponent is standalone and required when using this component.	Content is optional unless the API requires a label or value.	None.

Accessible names, descriptions, and form labels remain required whenever the component’s purpose cannot otherwise be determined, even when the corresponding visual part is optional.

Framework parity and differences

The adapters target the same user-visible behavior and accessibility contract. Their public shapes follow each framework’s conventions and are not expected to be symbol-for-symbol identical.

Concern	Contract
Public composition	All adapters export 1 public symbol, with framework-idiomatic names.
State and change events	React uses controlled/default props and callbacks; Vue uses v-model; Angular uses [(value)].
Children and content	React uses children; Vue uses the slots listed above; Angular uses the documented content projection selectors.
Native attributes	React forwards the named native interface; Vue follows the stated fallthrough rule; Angular attributes apply to the component host unless an input, directive, or documented native root consumes them.
Imperative access	React forwards native refs; Vue exposes no methods; Angular exposes the listed class methods through a template reference or ViewChild.

These differences are intentional adapter design. Behavioral or accessibility differences not stated on this page are parity defects rather than supported variations.

Form integration

Use name="password" to serialize the current value under the documented field name. The examples initialize the field, keep its value application-owned, forward disabled and required, render an accessible error, and read the browser submission payload. This component has no public invalid prop; announce validation errors next to the labeled control and use native validity where available.

React

const initial = '';
const [value, setValue] = useState(initial);
const [errors, setErrors] = useState<Record<string, string>>({});

<form onSubmit={(event) => {
  event.preventDefault();
  const data = new FormData(event.currentTarget);
  // Submit data.get('password').
}}>
  <PasswordInput name="password" value={value} onChange={(event) => setValue(event.currentTarget.value)}
    required disabled={isDisabled} />
  {errors.password && <p role="alert">{errors.password}</p>}
  <button type="submit">Submit</button>
</form>

Vue

<script setup lang="ts">
import { reactive, ref } from 'vue';
const initial = '';
const value = ref(initial);
const errors = reactive<Record<string, string>>({});
function submit(event: Event) {
  const data = new FormData(event.currentTarget as HTMLFormElement);
  // Submit data.get('password').
}
</script>

<form @submit.prevent="submit">
  <PasswordInput v-model="value" name="password" required :disabled="isDisabled"></PasswordInput>
  <p v-if="errors.password" role="alert">{{ errors.password }}</p>
  <button type="submit">Submit</button>
</form>

Angular

initial = '';
value = this.initial;
errors: Record<string, string> = {};
submit(form: HTMLFormElement) {
  const data = new FormData(form);
  // Submit data.get('password').
}

<form #form (submit)="submit(form); $event.preventDefault()">
  <simurgh-password-input [(value)]="value" name="password" required [disabled]="isDisabled"></simurgh-password-input>
  <p *ngIf="errors.password" role="alert">{{ errors.password }}</p>
  <button type="submit">Submit</button>
</form>

For Angular reactive or template-driven forms, bridge the documented value/valueChange pair to your form control. The component does not implement ControlValueAccessor; update disabled and validation state from the Angular form explicitly.

Supported states

The table distinguishes component behavior from application-owned presentation. “Not supported” means there is no public state contract for that adapter; do not invent one with an undocumented attribute. Keep status and error messages accessible when they are rendered outside the component.

State	React	Vue	Angular
Loading	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Empty	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Invalid	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Read-only	Supported with readOnly={true}; focus and value submission remain available while editing is blocked.	Supported with :readonly="true"; focus and value submission remain available while editing is blocked.	Supported with [readonly]="true"; focus and value submission remain available while editing is blocked.
Disabled	Supported with disabled={true} on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.	Supported with :disabled="true" on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.	Supported with [disabled]="true" on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.
Error	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.

Styling contract

Styling contract

The selectors below are used by the published component recipe or emitted consistently by an adapter. Treat these as the supported styling surface. Element order, anonymous wrappers, and undocumented descendants are implementation details and should not be targeted.

Surface	Stable hooks
Recipe classes	No component-specific recipe class; this stylesheet currently imports shared tokens only.
Stable DOM parts	[data-slot="password-input"], [data-slot="password-input-control"], [data-slot="password-input-toggle"]
Stable data attributes	[data-disabled], [data-slot]
ARIA/state selectors used by the recipe	No ARIA state selector is used by this recipe.
CSS custom properties consumed	--simurgh-accent, --simurgh-background, --simurgh-border, --simurgh-foreground, --simurgh-ring, --simurgh-surface

Prefer a semantic token override for theme-wide changes. Use the listed class or part selectors for a component-scoped override. When omitting recipe CSS, preserve state attributes and ARIA semantics even if your replacement styles use different selectors.

Customization

Load the optional component stylesheet for the default recipe, override semantic tokens for broad theme changes, or omit the recipe CSS for headless styling. See theming and styling hooks for import order, selectors, dark mode, RTL, and reduced-motion guidance.

Last verified on 2026-08-13 against Simurgh registry 0.1.1.

Related components

• Review the shared accessibility and RTL guidance and theming and styling hooks.
• Use the component chooser and component overview to compare related primitives.
• Inspect the registry manifest and framework source for React, Vue, or Angular.