Skip to main content

Interface: StandardInputProperties

Defined in: shared/types/componentProps.ts:412

Input field properties combining form and interaction patterns.

Remarks​

This interface provides a standard template for input components with consistent typing and behavior patterns.

Hierarchy​

View Summary

Extends​

Properties​

children?​

readonly optional children?: ReactNode;

Defined in: shared/types/componentProps.ts:36

Component content (text, elements, or other components)

Inherited from​

CoreComponentProperties.children

className?​

readonly optional className?: string;

Defined in: shared/types/componentProps.ts:38

Additional CSS classes for styling customization

Inherited from​

CoreComponentProperties.className

disabled?​

readonly optional disabled?: boolean;

Defined in: shared/types/componentProps.ts:40

Whether the component is disabled and non-interactive

Inherited from​

CoreComponentProperties.disabled

aria-describedby?​

readonly optional aria-describedby?: string;

Defined in: shared/types/componentProps.ts:89

ARIA described-by reference for additional descriptions

Inherited from​

AccessibilityProperties.aria-describedby

aria-disabled?​

readonly optional aria-disabled?: boolean;

Defined in: shared/types/componentProps.ts:91

ARIA disabled state for interactive controls that are visually disabled

Inherited from​

AccessibilityProperties.aria-disabled

aria-label?​

readonly optional aria-label?: string;

Defined in: shared/types/componentProps.ts:93

ARIA label for screen readers

Inherited from​

AccessibilityProperties.aria-label

aria-labelledby?​

readonly optional aria-labelledby?: string;

Defined in: shared/types/componentProps.ts:95

ARIA labelledby reference for complex labeling

Inherited from​

AccessibilityProperties.aria-labelledby

aria-level?​

readonly optional aria-level?: number;

Defined in: shared/types/componentProps.ts:97

ARIA heading level for elements using role="heading"

Inherited from​

AccessibilityProperties.aria-level

role?​

readonly optional role?: string;

Defined in: shared/types/componentProps.ts:99

Role attribute for semantic meaning

Inherited from​

AccessibilityProperties.role

tabIndex?​

readonly optional tabIndex?: number;

Defined in: shared/types/componentProps.ts:101

Tab index for keyboard navigation

Inherited from​

AccessibilityProperties.tabIndex

error?​

readonly optional error?: string;

Defined in: shared/types/componentProps.ts:183

Error message to display when validation fails

Inherited from​

FormFieldBaseProperties.error

helpText?​

readonly optional helpText?: string;

Defined in: shared/types/componentProps.ts:185

Help text to provide guidance to users

Inherited from​

FormFieldBaseProperties.helpText

id​

readonly id: string;

Defined in: shared/types/componentProps.ts:187

Unique identifier for the field (required for accessibility)

Inherited from​

FormFieldBaseProperties.id

label​

readonly label: string;

Defined in: shared/types/componentProps.ts:189

Label text to display for the field

Inherited from​

FormFieldBaseProperties.label

required?​

readonly optional required?: boolean;

Defined in: shared/types/componentProps.ts:191

Whether the field is required for form submission

Inherited from​

FormFieldBaseProperties.required

onBlur?​

readonly optional onBlur?: BlurHandler<HTMLInputElement>;

Defined in: shared/types/componentProps.ts:418

Blur event handler

onChange​

readonly onChange: ChangeHandler;

Defined in: shared/types/componentProps.ts:420

Value change handler

onFocus?​

readonly optional onFocus?: FocusHandler<HTMLInputElement>;

Defined in: shared/types/componentProps.ts:422

Focus event handler

placeholder?​

readonly optional placeholder?: string;

Defined in: shared/types/componentProps.ts:424

Placeholder text for empty inputs

type?​

readonly optional type?: "number" | "url" | "text" | "password" | "email";

Defined in: shared/types/componentProps.ts:426

Input type for different input behaviors

value​

readonly value: string;

Defined in: shared/types/componentProps.ts:433

Current input value