Password Input

Password field with visibility toggle and safe keyboard/autofill defaults; caller overrides remain authoritative.

Identity

Category: Forms & selection
Status: stable public Registry/export-map component family
Targets: iOS · Android · Web, subject to the compatibility contract
Prerequisites: @beemvp/beeui-ui installed (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup.
Source: packages/ui/src/components/password-input.tsx

Import

import { PasswordInput } from '@beemvp/beeui-ui';

There is no documented deep/private source import. For source ownership from a BeeUI checkout:

pnpm beeui add password-input

Registry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.

Composition and public API

Primary export: PasswordInput
- Also routed here, outside the Registry family:
  - password-input
- Package export subpath: @beemvp/beeui-ui/password-input

Exported types: PasswordInputProps

The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.

State and behavior contract

Uncontrolled-by-default text field (same contract as Input) with a visibility-toggle affordance; toggling visibility never changes the caller-owned secureTextEntry/autofill overrides, which remain authoritative. showLabel/hideLabel drive both the toggle button’s visible text and its accessible name for the masked/visible states respectively (defaulting to the English 'Show password'/'Hide password') — a localized app passes both to replace the rendered text, not just the announced name.

Props

`PasswordInputProps`

Prop	Type	Default	Description
`containerClassName`	`string`	—	Extra utility classes for the overlay’s container element, merged after the component’s own.
`defaultVisible`	`boolean`	`false`	Initial visibility for uncontrolled usage. Defaults to false (masked).
`hideLabel`	`string`	`'Hide password'`	Both the toggle button’s visible text and its accessible name when the password is currently visible (pressing it hides it) — e.g. localize to `'Ẩn'` for a short Vietnamese label. Defaults to `'Hide password'`.
`onVisibleChange`	`(visible: boolean) => void`	—	Called with the next visibility whenever the show/hide toggle is pressed.
`showLabel`	`string`	`'Show password'`	Both the toggle button’s visible text and its accessible name when the password is currently masked (pressing it shows it) — e.g. localize to `'Hiện'` for a short Vietnamese label. Defaults to `'Show password'`.
`toggleClassName`	`string`	—	Applied to the show/hide toggle `Button`, not the input.
`visible`	`boolean`	—	Controls whether the password is shown in plain text (`true`) or masked via `secureTextEntry` (`false`). Passing this switches visibility to controlled mode.

Also carries every prop of Omit<InputProps, 'secureTextEntry'> — documented on the Input page, not reproduced here.

The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.

Provider and dependencies

No additional provider is required by this family. BeeUIProvider remains the recommended application root.
Peer/native dependencies visible to this Registry item: react, react-native
Registry dependency closure: box, button, core-cn, input, theme
Safe-area ownership remains explicit: shell surfaces touching system edges opt into SafeArea; components do not silently invent app-shell insets.
Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.

Platform behavior

This family ships no platform-specific file, and its own source takes no Platform branch.

The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.

Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.

Accessibility

Roles this family assigns: none set in password-input.tsx.
Accessibility states and properties it sets: accessibilityLabel — read from password-input.tsx.

Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.

Styling and theming

Style axes: size (3 values, inherited from InputProps).
Class-name surfaces: className, containerClassName, toggleClassName.

Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.

Executable examples

Primary executable fixture: apps/showcase/__tests__/component-contracts.test.tsx
Additional fixture: apps/showcase/__tests__/input-masked-accessibility-value.test.tsx
Additional fixture: apps/showcase/__tests__/issue-7-hardening.test.tsx
Additional fixture: apps/showcase/__tests__/password-input-visible-toggle-text.test.tsx

Addressable examples

Each link below opens the Showcase at that exact example, not at the top of the gallery:

basic — smallest meaningful complete usage

The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.

Live Web preview

This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.

Composition anatomy

Family root / primary export: PasswordInput
- Exported type surface:
  - PasswordInputProps

The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.

Verified example source

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Password Input is actually used: 3 lines in 1 place. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.

Imports the examples below need (a filtered subset of the fixture’s own top-level imports):

import { Field, PasswordInput } from '@beemvp/beeui-ui';

lines 603–605:

              <Field label="Password">
                <PasswordInput placeholder="Enter password" />
              </Field>

Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.

Limitations

Masking follows visible alone; the underlying secure-entry flag is not accepted.