FormPassword
FormPassword
Section titled “FormPassword”Form password component with theme-aware styling and optional show/hide toggle
Uses CSS custom properties from @sparkle/theme for consistent theming across light/dark modes and supports validation states with semantic colors.
Import
Section titled “Import”import { FormPassword } from '@sparkle/ui'| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
size | "sm" | "md" | "lg" | undefined | “ | Size variant for the password input | |
validationState | "default" | "success" | "error" | undefined | “ | Validation state for styling | |
placeholder | string | undefined | “ | Password placeholder text | |
disabled | boolean | undefined | “ | Whether the field is disabled | |
required | boolean | undefined | “ | Whether the field is required | |
showToggle | boolean | undefined | “ | Whether to show the toggle button to reveal/hide password | |
value | string | undefined | “ | Input value | |
onChange | ((event: React.ChangeEvent<HTMLInputElement>) => void) | undefined | “ | Input change handler | |
onFocus | ((event: React.FocusEvent<HTMLInputElement, Element>) => void) | undefined | “ | Input focus handler | |
onBlur | ((event: React.FocusEvent<HTMLInputElement, Element>) => void) | undefined | “ | Input blur handler | |
onKeyDown | ((event: React.KeyboardEvent<HTMLInputElement>) => void) | undefined | “ | Input key down handler for keyboard navigation |
Theme Integration
Section titled “Theme Integration”This component uses CSS custom properties from @sparkle/theme for consistent styling across light and dark modes.
Design Tokens Used
Section titled “Design Tokens Used”--theme-*: Uses theme design tokens for consistent styling
You can customize the appearance by:
- Theme Variables: Modify theme tokens in your
@sparkle/themeconfiguration - CSS Classes: Apply custom CSS classes via the
classNameprop - CSS-in-JS: Use styled-components or emotion with the component
Accessibility
Section titled “Accessibility”This component follows accessibility best practices with proper ARIA attributes and keyboard support.
Related Components
Section titled “Related Components”- Form
- FormControl
- FormDescription
- FormField
- FormInput
- FormLabel
- FormMessage
- FormSelect
- FormSelectItem
- FormSubmit
- FormTextarea