@fictjs/password-toggle-field
v0.3.3
Published
Password toggle field primitives for Fict UI primitives.
Maintainers
Readme
@fictjs/password-toggle-field
Password toggle field primitives for Fict, modeled after @radix-ui/react-password-toggle-field. A password input paired with a button that shows/hides the entered value.
Part of ui-primitives, a port of Radix Primitives to Fict.
Unstable API — exported as
unstable_PasswordToggleFieldfrom@fictjs/radix-ui. The surface may change in a minor release.
Installation
pnpm add @fictjs/password-toggle-field fictUsage
/** @jsxImportSource fict */
import * as PasswordToggleField from '@fictjs/password-toggle-field'
export function Example() {
return (
<PasswordToggleField.Root>
<PasswordToggleField.Input />
<PasswordToggleField.Toggle>
<PasswordToggleField.Icon visible={<span>🙈</span>} hidden={<span>👁️</span>} />
</PasswordToggleField.Toggle>
</PasswordToggleField.Root>
)
}Anatomy
Root—visible/defaultVisible,onVisibilityChange.Input— the passwordinput; type flips betweenpasswordandtext.Toggle— the show/hide button.Icon— renders different content for thevisibleandhiddenstates;Slotfor custom composition.
Exports
- Components:
PasswordToggleField(Root),PasswordToggleFieldInput(Input),PasswordToggleFieldToggle(Toggle),PasswordToggleFieldSlot(Slot),PasswordToggleFieldIcon(Icon). - Types:
PasswordToggleFieldProps,PasswordToggleFieldInputProps,PasswordToggleFieldToggleProps,PasswordToggleFieldSlotProps,PasswordToggleFieldIconProps.
Documentation
The API mirrors @radix-ui/react-password-toggle-field. See the Radix Primitives docs, the ui-primitives overview, and the architecture guide.
License
MIT © Fict contributors.
