ComponentsPasswordField
Version 0.9.1

PasswordField

A password field component for your forms.

Usage#

import { PasswordField } from '@backstage/ui';

<PasswordField />

API reference#

PropTypeDefaultResponsive
size
smallmedium
smallYes
label
string
-No
icon
ReactNode
-No
description
string
-No
name
string
-No
className
string
-No
style
CSSProperties
-No

Examples#

Sizes#

We support two different sizes: small, medium.

<Flex direction="row" gap="4">
  <PasswordField size="small" placeholder="Small" icon={<Icon name="sparkling" />} />
  <PasswordField size="medium" placeholder="Medium" icon={<Icon name="sparkling" />} />
</Flex>

With description#

Here's a simple PasswordField with a description.

Description
<PasswordField label="Label" description="Description" placeholder="Enter a secret" />

Theming#

Our theming system is based on a mix between CSS classes, CSS variables and data attributes. If you want to customise this component, you can use one of these class names below.

  • bui-PasswordField
  • bui-PasswordField[data-size="small"]
  • bui-PasswordField[data-size="medium"]
  • bui-PasswordFieldInputWrapper
  • bui-PasswordFieldInput
  • bui-PasswordFieldIcon
  • bui-PasswordFieldVisibility

Changelog#

  • 0.9.0 - Improved visual consistency of PasswordField, SearchField, and MenuAutocomplete components. #31679
  • 0.8.0 - BREAKING: Added a new PasswordField component. As part of this change, the password and search types have been removed from TextField. #31238