Skip to content

TextInput

Alpha

TextInput is a form component to add default styling to the native text input.

Note: Don't forget to set aria-label to make the TextInput accessible to screen reader users.

Default example

Text Input with icons

Text Input with text visuals

Text Input with error and warning states

Block text input

Contrast text input

Props

TextInput

NameTypeDefaultDescription
aria-label
string
Allows input to be accessible.
block
boolean
falseCreates a full width input element
contrast
boolean
falseChanges background color to a higher contrast color
size
'small' | 'medium' | 'large'
Creates a smaller or larger input than the default.
leadingVisual
string | React.ComponentType
Visual positioned on the left edge inside the input
trailingVisual
string | React.ComponentType
Visual positioned on the right edge inside the input
validationStatus
'warning' | 'error'
Style the input to match the status
variant Deprecated
'small' | 'medium' | 'large'
(Use size) Creates a smaller or larger input than the default.
width Deprecated
string | number | Array<string | number>
(Use sx prop) Set the width of the input
maxWidth Deprecated
string | number | Array<string | number>
(Use sx prop) Set the maximum width of the input
minWidth Deprecated
string | number | Array<string | number>
(Use sx prop) Set the minimum width of the input
icon Deprecated
React.ComponentType
(Use leadingVisual or trailingVisual) An Octicon React component. To be used inside of input. Positioned on the left edge.
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.
ref
React.RefObject<HTMLInputElement>
A ref to the element rendered by this component.
Additional props are passed to the <input> element. See MDN for a list of props accepted by the <input> element.

Status

Alpha

  • Component props are documented on primer.style/react.
  • Component does not have any unnecessary third-party dependencies.
  • Component can adapt to different themes.
  • Component can adapt to different screen sizes.
  • Component has 100% test coverage.

Beta

  • Component is used in a production application.
  • Common usage examples are documented on primer.style/react.
  • Common usage examples are documented in storybook stories.
  • Component has been reviewed by a systems designer and any resulting issues have been addressed.
  • Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Stable

  • Component API has been stable with no breaking changes for at least one month.
  • Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
  • Component has corresponding design guidelines documented in the interface guidelines.
  • Component has corresponding Figma component in the Primer Web library.