DocsBlog

Get Started

Components

Data Grid

Signals

Styling

Theming

↑↓Navigate
↵Select
EscClose
  • 1.8.0

  • Day

    Night

    Preview

    Switch mode
  • cerberus

    acheron

    elysium

    oceanus

Get Started
Components
Data Grid
Signals
Styling
Theming

Concepts

OverviewCompositionCerberus ContextTesting

Layout

Aspect RatioBleedBoxCenterContainerContainer QueryDividerFlexFloatGridGroupLink OverlayScrollableStackWrap

Components

AccordionAdmonitionAvatarButtonCarouselCheckboxClipboardCollapsibleComboboxConfirm ModalCTA ModalDate PickerDialogFieldFieldsetFile UploaderIconButtonInputLoading StatesMarqueeMenuNotificationsNumber InputPaginationPin InputPopoverProgress IndicatorsPrompt ModalRadioRatingSelectSliderSplit ButtonSwitchTableTabsTagTextTextareaToggleTooltip

Utilities

Client OnlyDownload TriggerEnvironmentFeature FlagsFocus TrapForFormat ByteFormat NumberFormat Relative TimeFormat Relative TimeFrameHighlightJSON Tree ViewLocalePortalPresenceShowSwapsplitPropsTheme

Input

The Input component displays a text-based input field.

  • npm
  • source
  • recipe
  • Ark
View as Markdown
Open this page in Markdown
Anthropic
Open in Claude
Ask questions about this page
OpenAI
Open in ChatGPT
Ask questions about this page

Import

import { Field, Input } from '@cerberus/react'

Usage

The Input component displays a text-based input field.

Loading example...

With Icons

You can utilize the startIcon or endIcon props to add icons to the input.

Loading example...

Note

When and input is marked as invalid, the endIcon will be replaced by the invalid icon.

Customizing

You can customize the input by passing styles directly into the component. The Input is a re-export of the FieldInput primitive.

Loading example...

API

Props

The Input accepts the following props in addition to any native input props:

NameDefaultDescription
startIconAn ElementType to display at the start of the input
endIconAn ElementType to display at the end of the input
sizeThis size variant of the input

The Input component also accepts any of the props from the FieldParts.Input primitive.

On this page

  • Import
  • Usage
  • With Icons
  • Customizing
  • API
    • Props
Edit this page on Github
We'll never share your email with anyone else.
A name is required to submit this form. It replaces the helper text.
This will help us learn more about you.0/300
Custom Helper Text