Date time picker
A date time picker allows the user to select an associated date and time.Installation
| Install | yarn add @atlaskit/datetime-picker |
|---|---|
| Source | Bitbucket.org, (opens new window) |
| npm | @atlaskit/datetime-picker, (opens new window) |
| Bundle | unpkg.com, (opens new window) |
Props
| Description | Set the appearance of the picker.
|
|---|---|
| Type | "default" | "subtle" | "none" |
| Description | Used to associate accessible descriptions to both the date and time
picker. If you want to associate individual accessible descriptions, this
should be done through the |
|---|---|
| Type | string |
| Description | Set the picker to autofocus on mount. |
|---|---|
| Type | boolean |
| Description | Set the |
|---|---|
| Type | string |
| Description | You should not be accessing this prop under any circumstances.
It is provided by |
|---|---|
| Type | (payload: AnalyticsEventPayload) => UIAnalyticsEvent |
| Description | Props applied to the |
|---|---|
| Type | DatePickerBaseProps |
| Description | The default for |
|---|---|
| Type | string |
| Description | Set the id of the field. |
|---|---|
| Type | string |
| Description | Props to apply to the container. If you are looking to set your width, use a |
|---|---|
| Type | AllHTMLAttributes<HTMLElement> |
| Description | Set if the field is disabled. |
|---|---|
| Type | boolean |
| Description | Set if the picker has an invalid value. |
|---|---|
| Type | boolean |
| Description | Set the field as required. |
|---|---|
| Type | boolean |
| Description | Locale used for formatting dates and times. See DateTimeFormat. |
|---|---|
| Type | string |
| Description | The name of the field. |
|---|---|
| Type | string |
| Description | Called when the field is blurred. |
|---|---|
| Type | (event: FocusEvent<HTMLInputElement, Element>) => void |
| Description | Called when the value changes and the date / time is a complete value, or empty. The only value is an ISO string or empty string. |
|---|---|
| Type | (value: string) => void |
| Description | Called when the field is focused. |
|---|---|
| Type | (event: FocusEvent<HTMLInputElement, Element>) => void |
| Description | Function used to parse datetime values into their date, time and timezone sub-values. * |
|---|---|
| Type | (dateTimeValue: string, date: string, time: string, timezone: string) => { dateValue: string; timeValue: string; zoneValue: string; } |
| Description | Allows getting a ref to the component instance.
Once the component unmounts, React will set @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} |
|---|---|
| Type | string | Ref<HTMLDivElement> |
| Description | The spacing for the select control. Compact is |
|---|---|
| Type | "default" | "compact" |
| Description | A
|
|---|---|
| Type | string |
| Description | Props applied to the |
|---|---|
| Type | TimePickerBaseProps |
| Description | The ISO time that should be used as the input value. |
|---|---|
| Type | string |