Input

Installation

Copy editable source into an initialized application:

pnpm dlx @simurgh-ui/cli add input

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

React

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

Vue

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

Angular

import { InputComponent } from '@simurgh-ui/angular/input';
import '@simurgh-ui/styles/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

Input preserves native form submission, browser validation, input types, required and disabled states, while exposing explicit invalid semantics.

Default presentation: native

The component preserves a familiar native element and browser behavior. The optional recipe harmonizes its appearance without replacing the platform interaction model.

Basic usage

Live component Input ◆

Email address

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). No uncontrolled prop is exposed. 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>

<Input v-model="state">…</Input>
<button @click="state = initial">Reset controlled</button>

Angular

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

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

Pair Input with Label and connect validation text using aria-describedby. The invalid option sets aria-invalid; it does not replace validation logic.

Examples

React

<Input name="email" type="email" required invalid={hasError} />

Vue

<Input v-model="email" name="email" type="email" required :invalid="hasError" />

Angular

<simurgh-input [(value)]="email" name="email" type="email" [required]="true" [invalid]="hasError" />

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: Input
• Vue exports: Input
• Angular exports: InputComponent

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.

Input

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

Prop	Type	Default / requirement
children	ReactNode	undefined
invalid	boolean	false
ref	Ref<HTMLInputElement> | undefined	undefined

Vue API reference

Vue

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

Input

Vue attribute fallthrough is enabled for the rendered root.

Prop	Type	Default / requirement
modelValue	[String, Number]	''
type	string	'text'
name	string	undefined
required	boolean	false
disabled	boolean	false
invalid	boolean	false

Event	Payload
update:modelValue	string | number | string
change	Event

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.

InputComponent

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

Input	Type	Default / requirement
type	string	'text'
name	string	undefined
value	string	''
required	boolean	false
disabled	boolean	false
invalid	boolean	false

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	Input is standalone and required when using this component.	Content is optional unless the API requires a label or value.	None.
Vue	Input is standalone and required when using this component.	Content is optional unless the API requires a label or value.	None.
Angular	InputComponent 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="email" 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. Set invalid when validation fails; it communicates visual/ARIA state but does not replace an error message.

React

const initial = 'ali@example.com';
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('email').
}}>
  <Input name="email" value={value} onChange={(event) => setValue(event.currentTarget.value)}
    required disabled={isDisabled} invalid={Boolean(errors.email)} />
  {errors.email && <p role="alert">{errors.email}</p>}
  <button type="submit">Submit</button>
</form>

Vue

<script setup lang="ts">
import { reactive, ref } from 'vue';
const initial = 'ali@example.com';
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('email').
}
</script>

<form @submit.prevent="submit">
  <Input v-model="value" name="email" required :disabled="isDisabled" :invalid="Boolean(errors.email)"></Input>
  <p v-if="errors.email" role="alert">{{ errors.email }}</p>
  <button type="submit">Submit</button>
</form>

Angular

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

<form #form (submit)="submit(form); $event.preventDefault()">
  <simurgh-input [(value)]="value" name="email" required [disabled]="isDisabled" [invalid]="!!errors.email"></simurgh-input>
  <p *ngIf="errors.email" role="alert">{{ errors.email }}</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	Supported with invalid={true}; also associate visible error text.	Supported with :invalid="true"; also associate visible error text.	Supported with [invalid]="true"; also associate visible error text.
Read-only	Supported with readOnly={true}; focus and value submission remain available while editing is blocked.	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.
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	Set the invalid state and render a separate labeled error message; invalid styling alone is not an error description.	Set the invalid state and render a separate labeled error message; invalid styling alone is not an error description.	Set the invalid state and render a separate labeled error message; invalid styling alone is not an error description.

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	.simurgh-trigger
Stable DOM parts	[data-slot="button"], [data-slot="checkbox"], [data-slot="input"], [data-slot="input-otp"], [data-slot="native-select"], [data-slot="pagination-link"], [data-slot="select-trigger"], [data-slot="toggle-group-item"], [data-slot="toolbar-button"]
Stable data attributes	[data-density], [data-slot]
ARIA/state selectors used by the recipe	[aria-invalid]
CSS custom properties consumed	--simurgh-control-height, --simurgh-control-padding, --simurgh-danger, --simurgh-disabled-foreground, --simurgh-disabled-surface, --simurgh-duration, --simurgh-foreground, --simurgh-input-border, --simurgh-input-surface, --simurgh-muted-foreground, --simurgh-radius, --simurgh-ring

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.