README
DateField
Description
A controlled date input component for single date, with validation states and a label.
Installation
yarn add @commercetools-uikit/date-field
npm --save install @commercetools-uikit/date-field
Additionally install the peer dependencies (if not present)
yarn add react
npm --save install react
Usage
import DateField from '@commercetools-uikit/date-field';
const Example = () => (
<DateField
title="Release Date"
value="2018-10-30"
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: , 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. | ||
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. | ||
value |
string |
✅ | Value of the input | |
onChange |
Function See signature. |
✅ | Called with an event containing the new value.
This is always called with either an empty string or a valid date in the format of YYYY-MM-DD .
Parent should pass it back as value . |
|
onBlur |
Function See signature. |
Called when input is blurred | ||
onFocus |
FocusEventHandler |
Called when input is focused | ||
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 | ||
minValue |
string |
A minimum selectable date. Must either be an empty string or a date formatted as "YYYY-MM-DD". | ||
maxValue |
string |
A maximum selectable date. Must either be an empty string or a date formatted as "YYYY-MM-DD". | ||
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. |
||
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
renderError
Signature (key: string, error?: boolean) => ReactNode;
onChange
Signature (event: TEvent) => void
onBlur
Signature (event: TEvent) => void
onInfoButtonClick
Signature () => void
props data-*
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 DateField
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 DateField
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:
- Input field for a single date