UI: PasswordField
A password input with a button that shows or hides the password. Import the token file once (@pithyx/ui/tokens.css) and wrap the app in UiProvider; see @pithyx/ui.
Generated from the TSDoc comments of @pithyx/ui 1.0.0-rc.9 at build time; the text below the headings is the comment in the source.
Interfaces
Section titled “Interfaces”PasswordFieldProps
Section titled “PasswordFieldProps”The props of PasswordField; autoComplete tells password managers what to do.
Extends
Section titled “Extends”Omit<TextFieldProps,"type"|"trailing">
Properties
Section titled “Properties”label: ReactNode;The visible label, also the accessible name.
Inherited from
Section titled “Inherited from”description?
Section titled “description?”optional description?: ReactNode;A hint below the input, announced with it.
Inherited from
Section titled “Inherited from”errorMessage?
Section titled “errorMessage?”optional errorMessage?: ReactNode;The text shown while the field is invalid (isInvalid or a failed validate).
Inherited from
Section titled “Inherited from”placeholder?
Section titled “placeholder?”optional placeholder?: string;A hint inside the empty input; never a replacement for the label.
Inherited from
Section titled “Inherited from”className?
Section titled “className?”optional className?: string;Extra class names for the field, added after its own.
Inherited from
Section titled “Inherited from”inputClassName?
Section titled “inputClassName?”optional inputClassName?: string;Extra class names for the input element.
Inherited from
Section titled “Inherited from”autoCapitalize?
Section titled “autoCapitalize?”optional autoCapitalize?: "none" | "characters";“none” for user names and codes, so phones do not capitalize the first letter.
Inherited from
Section titled “Inherited from”Omit.autoCapitalize;autoComplete
Section titled “autoComplete”autoComplete: 'current-password' | 'new-password';current-password to sign in, new-password to set one.
Overrides
Section titled “Overrides”Omit.autoComplete;Functions
Section titled “Functions”PasswordField()
Section titled “PasswordField()”function PasswordField(props): Element;A password input with a button that shows or hides the password. The button’s label comes from the package’s own
texts in the language of the nearest UiProvider.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
props |
PasswordFieldProps |
The props of TextField without type and trailing, plus the required autoComplete. |
Returns
Section titled “Returns”Element
The password field.