Password API

API documentation for Password component

PasswordRoot#

Props#

State#

Exposes#

Events#

Interfaces#

Types#

PasswordInput#

Props#

Exposes#

Interfaces#

Types#

PasswordStrength#

Props#

Exposes#

Interfaces#

Types#

PasswordMeter#

Props#

Exposes#

Interfaces#

Types#

PasswordPortal#

Props#

Exposes#

Interfaces#

Types#

PasswordClearIcon#

Props#

Exposes#

Interfaces#

Types#

usePassword#

Props#

Props for the usePassword hook.

name	type	default	description
value	string	null	The controlled value of the password input.
defaultValue	string	null	The default value for uncontrolled mode.
mask	boolean	null	The controlled mask state of the password input. When true, the password is hidden. When false, the password is visible.
defaultMask	boolean	null	The default mask state for uncontrolled mode.
onValueChange	(event: usePasswordValueChangeEvent) => void	null	Callback fired when the password value changes.
onMaskChange	(event: usePasswordMaskChangeEvent) => void	null	Callback fired when the mask state changes.

State#

Defines valid state in usePassword.

name	type	default	description
value	string	null	Current password value.
mask	boolean	null	Whether the password is masked.

Exposes#

Defines the methods and properties exposed by usePassword.

name	type	default	description
state	usePasswordState	null	The state of the usePassword.
onInputChange	(event: ChangeEvent<HTMLInputElement>) => void	null	Handle input change.
toggleMask	() => void	null	Toggle the mask state of the password.

Events#

usePasswordValueChangeEvent

Event object for value change callback.

name	type	description
value	string	The new password value.
originalEvent	E	The original DOM event.

usePasswordMaskChangeEvent

Event object for mask change callback.

name	type	description
value	boolean	Whether the password is masked.

Types#

Instance

Instance of usePassword headless.

values
HeadlessInstance<usePasswordProps, usePasswordState, usePasswordExposes>