Skip to content

PasswordInputProps

Defined in: react/components/controls/input.tsx:43

Props for PasswordInput (InputProps without type).

optional children?: ReactNode

Defined in: react/components/types.ts:38

Child elements.

ComponentProps.children


optional className?: string

Defined in: react/components/types.ts:24

Space-separated class names (currently advisory; no CSS cascade).

ComponentProps.className


optional disabled?: boolean

Defined in: react/components/types.ts:52

Marks the widget (and its descendants) as inert: not focusable, ignores key/mouse input, and interactive controls render in a muted style. A disabled container propagates to every control inside it.

ComponentProps.disabled


optional focusable?: boolean

Defined in: react/components/types.ts:40

Allow this widget to take keyboard focus.

ComponentProps.focusable


optional focusOnClick?: boolean

Defined in: react/components/types.ts:46

When a click lands on this container (its padding, border, or a non-focusable child), move focus to its first focusable descendant — so clicking a Form/Panel/Box hands focus to its first field. Off by default.

ComponentProps.focusOnClick


optional hoverInterest?: boolean

Defined in: react/components/types.ts:66

Opt-in hint that this widget cares about passive hover movement.

ComponentProps.hoverInterest


optional icon?: string

Defined in: react/components/controls/input.tsx:26

Leading icon name.

InputProps.icon


optional id?: string

Defined in: react/components/types.ts:22

Stable identifier, handy for tests and lookups.

ComponentProps.id


optional invalid?: boolean

Defined in: react/components/controls/input.tsx:30

Force the invalid (error) style regardless of validators.

InputProps.invalid


optional label?: string

Defined in: react/components/types.ts:36

Structural/accessible label (also the tab title inside TabContainer).

ComponentProps.label


optional onChange?: (val) => void

Defined in: react/components/controls/input.tsx:16

Called with the new text on every edit.

string

void

InputProps.onChange


optional onClick?: (ev) => void

Defined in: react/components/types.ts:54

Pointer click.

any

void

ComponentProps.onClick


optional onDismiss?: () => void

Defined in: react/components/controls/input.tsx:20

Called when Escape is pressed — e.g. to cancel an inline editor.

void

InputProps.onDismiss


optional onDragEnd?: (x, y, moved) => void

Defined in: react/components/types.ts:72

Drag released; moved is false for a tap with no movement.

number

number

boolean

void

ComponentProps.onDragEnd


optional onDragMove?: (x, y) => void

Defined in: react/components/types.ts:70

Pointer moved while dragging from this widget.

number

number

void

ComponentProps.onDragMove


optional onDragStart?: (x, y) => void

Defined in: react/components/types.ts:68

Pointer-drag lifecycle; moved is false for a tap with no movement.

number

number

void

ComponentProps.onDragStart


optional onKey?: (ev) => void

Defined in: react/components/controls/input.tsx:12

Key handler (set ev.handled to consume).

any

void

InputProps.onKey


optional onMouseDown?: (ev) => void

Defined in: react/components/types.ts:56

Pointer pressed (any button); the event carries button and x/y.

any

void

ComponentProps.onMouseDown


optional onMouseEnter?: (ev) => void

Defined in: react/components/types.ts:62

Pointer entered this widget’s region.

any

void

ComponentProps.onMouseEnter


optional onMouseLeave?: (ev) => void

Defined in: react/components/types.ts:64

Pointer left this widget’s region.

any

void

ComponentProps.onMouseLeave


optional onScroll?: (ev) => void

Defined in: react/components/types.ts:60

Wheel / scroll event.

any

void

ComponentProps.onScroll


optional onSubmit?: (val) => void

Defined in: react/components/controls/input.tsx:18

Called with the current text when Enter is pressed.

string

void

InputProps.onSubmit


optional onValidate?: (result) => void

Defined in: react/components/controls/input.tsx:36

Called after each validation with the normalized result.

ValidationResult

void

InputProps.onValidate


optional placeholder?: string

Defined in: react/components/controls/input.tsx:22

Hint text shown when empty.

InputProps.placeholder


optional ref?: Ref<Widget>

Defined in: react/components/types.ts:30

Captures the underlying widget instance (React 19 ref-as-prop). Defaults to the base Widget; narrow it with a cast when you need a subclass field, e.g. ref={inputRef as React.Ref<InputWidget>}.

ComponentProps.ref


optional style?: WidgetStyles

Defined in: react/components/types.ts:32

Inline styles for this widget — see the Styling guide.

ComponentProps.style


optional suffixIcon?: string

Defined in: react/components/controls/input.tsx:28

Trailing icon name.

InputProps.suffixIcon


optional theme?: string

Defined in: react/components/types.ts:34

Re-theme this subtree; descendants resolve $tokens against it.

ComponentProps.theme


optional validateOn?: ValidateTrigger

Defined in: react/components/controls/input.tsx:34

When the field re-validates itself (default “blur”).

InputProps.validateOn


optional validators?: Validator[]

Defined in: react/components/controls/input.tsx:32

Validators run on this field; failures recolor the border/icon.

InputProps.validators


optional value?: string

Defined in: react/components/controls/input.tsx:14

Current text (controlled).

InputProps.value