@commercetools-uikit/password-field

A controlled text input component for passwords with validation states.

Usage no npm install needed!

<script type="module">
  import commercetoolsUikitPasswordField from 'https://cdn.skypack.dev/@commercetools-uikit/password-field';
</script>

README

PasswordField

Description

A controlled text input component for passwords with validation states.

Installation

yarn add @commercetools-uikit/password-field
npm --save install @commercetools-uikit/password-field

Additionally install the peer dependencies (if not present)

yarn add react react-intl
npm --save install react react-intl

Usage

import PasswordField from '@commercetools-uikit/password-field';

const Example = () => (
  <PasswordField
    title="myPassword"
    value="s3cr3t"
    onChange={(event) => alert(event.target.value)}
  />
);

export default Example;

Properties

Props Type Required Default Description
id string Used as HTML id property. An id is auto-generated when it is not specified.
horizontalConstraint union
Possible values:
, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto'
'scale' Horizontal size limit of the input fields.
errors Record A map of errors. Error messages for known errors are rendered automatically.
Unknown errors will be forwarded to renderError
renderError Function
See signature.
Called with custom errors. This function can return a message which will be wrapped in an ErrorMessage. It can also return null to show no error.
Signature: (key, error) => React.node
isRequired boolean Indicates if the value is required. Shows an the "required asterisk" if so.
touched boolean Indicates whether the field was touched. Errors will only be shown when the field was touched.
name string Used as HTML name of the input component. property
value string Value of the input component.
onChange ChangeEventHandler Called with an event containing the new value. Required when input is not read only. Parent should pass it back as value.
Signature: (event) => void
onBlur FocusEventHandler Called when input is blurred
Signature: (event) => void
onFocus FocusEventHandler Called when input is focused
Signature: (event) => void
isAutofocussed boolean Focus the input on initial render
isDisabled boolean Indicates that the input cannot be modified (e.g not authorized, or changes currently saving).
isReadOnly boolean Indicates that the field is displaying read-only content
placeholder string Placeholder text for the input
autoComplete union
Possible values:
'on' , 'off' , 'current-password' , 'new-password'
Password autocomplete mode
title union
Possible values:
string , ReactNode
Title of the label
hint union
Possible values:
string , ReactNode
Hint for the label. Provides a supplementary but important information regarding the behaviour of the input (e.g warn about uniqueness of a field, when it can only be set once), whereas description can describe it in more depth. Can also receive a hintIcon.
description union
Possible values:
string , ReactNode
Provides a description for the title.
onInfoButtonClick Function
See signature.
Function called when info button is pressed.
Info button will only be visible when this prop is passed.
Signature: (event) => void
hintIcon ReactElement Icon to be displayed beside the hint text.
Will only get rendered when hint is passed as well.
badge ReactNode Badge to be displayed beside the label.
Might be used to display additional information about the content of the field (E.g verified email)

Signatures

Signature renderError

(key: string, error?: boolean) => ReactNode;

Signature onInfoButtonClick

(
  event: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>
) => void

data-* props

The component further forwards all data- attributes to the underlying input component.

errors

This object is a key-value map. The renderError prop will be called for each entry with the key and the value. The return value will be rendered inside an ErrorMessage component underneath the input.

The PasswordField supports some errors out of the box. Return undefined from renderError for these and the default errors will be shown instead. This prevents consumers from having to reimplement the same error messages for known errors while still keeping the flexibility of showing custom error messages for them.

When the key is known, and when the value is truthy, and when renderError returned undefined for that error entry, then the TextField will render an appropriate error automatically.

Known error keys are:

  • missing: tells the user that this field is required

Main Functions and use cases are:

  • Password field in login forms