Skip to content

Input

Single-line text input with semantic focus/invalid/disabled states and Field-provided accessibility.

  • 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/input.tsx
import { Input, inputVariants } from '@beemvp/beeui-ui';

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

Terminal window
pnpm beeui add 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.

  • Family exports: Input inputVariants
    • Also routed here, outside the Registry family:
      • input
    • Package export subpath: @beemvp/beeui-ui/input

Exported types: InputProps

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.

Uncontrolled-by-default text field (standard React Native value/onChangeText); invalid/disabled/focus state drive semantic styling, while label/required/error metadata come from a wrapping Field, not from Input itself. A wrapping Field’s required state reaches this control only through its own aria-required prop (true when the field is required) — no English word is injected into the accessible name unless the field also sets a localized required label.

Prop Type Default Description
className string — Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.
disabled boolean — Sets editable={false} (unless editable is already explicitly false) and applies disabled styling. ORed with the enclosing Field’s own disabled. Defaults to false.
invalid boolean — Applies destructive border styling and, when true, uses the enclosing Field’s error (instead of its description) as this input’s accessibility hint. ORed with the enclosing Field’s own invalid. Defaults to false.
size 'sm' | 'md' | 'lg' 'md' Chooses this element’s size from inputVariants’s presets, declared in packages/ui/src/components/input.tsx — the classes each value applies are there.

Also carries every prop of TextInputProps — that upstream contract is 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.

  • 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: core-cn, field-context, text, 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.

This family ships no platform-specific file, but its source branches on Platform, so some behavior differs by target.

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.

  • Roles this family assigns: none set in input.tsx.
  • Accessibility states and properties it sets: accessibilityHint, accessibilityLabel, accessibilityLabelledBy, describedby (Web), disabled, required — read from 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.

  • Style axes: size (3 values) — the values are in the props tables above.
  • Class-name surfaces: className.

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.

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

  • basic — smallest meaningful complete usage
  • states — the states example

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

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.

  • Family root / primary export: Input
    • Public composition parts / helpers:
      • inputVariants
    • Exported type surface:
      • InputProps

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.

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Input is actually used: 18 lines in 5 places. 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, Input, Popover, Sheet } from '@beemvp/beeui-ui';
import * as React from 'react';

lines 160–162:

<Field label="Note">
<Input accessibilityLabel="Popover note" testID="popover-demo-input" />
</Field>

Fixture state this block reads (same file, line 461):

const [notifications, setNotifications] = React.useState(true);

lines 597–599:

<Field description="Used only for account notifications." label="Email" required testID="component-gallery-field">
<Input autoCapitalize="none" placeholder="you@example.com" />
</Field>

lines 613–618:

<Field error="Enter a valid project name." invalid label="Project name" testID="field-invalid-state">
<Input placeholder="Invalid value" />
</Field>
<Field disabled label="Managed field" testID="field-disabled-state">
<Input placeholder="Disabled by field context" />
</Field>

lines 722–724:

<Field label="Project name">
<Input defaultValue="BeeUI" />
</Field>

lines 759–761:

<Field label="Search">
<Input accessibilityLabel="Sheet search" testID="sheet-demo-input" />
</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.

An explicit accessibilityLabel, or an explicit accessibility hint, replaces the label, description and error a wrapping Field supplies — but not the label association, which is forwarded unconditionally, so on Web an input that names itself is still pointed at the field’s label as well. disabled cannot be undone by the editable flag: that flag can only turn editing off, never back on.

Implementation note: On Web, react-native-web’s own TextInput calls stopPropagation() on every keydown while it holds focus, so a document/window keydown listener registered in the default bubble phase never fires while an Input, SearchInput, or Textarea is focused. Register app-level keyboard shortcuts in the capture phase instead: document.addEventListener('keydown', handler, true). This is a react-native-web behavior, not something BeeUI opts you out of per-field today.