@atlaskit/datetime-picker 12.3.0 → 12.3.2

package/dist/types-ts4.0/components/date-time-picker.d.ts

@@ -1,218 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { jsx } from '@emotion/react';
-import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
-import { SelectProps } from '@atlaskit/select';
-import { Appearance, Spacing } from '../types';
-import { DatePickerBaseProps as DatePickerProps } from './date-picker';
-import { TimePickerBaseProps as TimePickerProps } from './time-picker';
-export interface DateTimePickerBaseProps extends WithAnalyticsEventsProps {
-    /**
-     * Set the appearance of the picker.
-     *
-     * `subtle` will remove the borders and background.
-     */
-    appearance?: Appearance;
-    /**
-     * Set the picker to autofocus on mount.
-     */
-    autoFocus?: boolean;
-    /**
-     * The default for `value`.
-     */
-    defaultValue?: string;
-    /**
-     * The id of the field. Currently, react-select transforms this to have a `react-select-` prefix, and an `--input` suffix when applied to the input. For example, the id `my-input` would be transformed to `react-select-my-input--input`.
-     * Keep this in mind when needing to refer to the ID. This will be fixed in an upcoming release.
-     */
-    id?: string;
-    /**
-     * Props to apply to the container. *
-     */
-    innerProps?: React.AllHTMLAttributes<HTMLElement>;
-    /**
-     * Set if the field is disabled.
-     */
-    isDisabled?: boolean;
-    /**
-     * The name of the field.
-     */
-    name?: string;
-    /**
-     * Called when the field is blurred.
-     */
-    onBlur?: React.FocusEventHandler<HTMLInputElement>;
-    /**
-     * 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.
-     */
-    onChange?: (value: string) => void;
-    /**
-     * Called when the field is focused.
-     */
-    onFocus?: React.FocusEventHandler<HTMLInputElement>;
-    /**
-     * The ISO time that should be used as the input value.
-     */
-    value?: string;
-    /**
-     * Set if users can edit the input, allowing them to add custom times.
-     */
-    timeIsEditable?: boolean;
-    /**
-     * Set if the picker has an invalid value.
-     */
-    isInvalid?: boolean;
-    /**
-     * Format the date with a string that is accepted by [date-fns's format function](https://date-fns.org/v1.29.0/docs/format).
-     */
-    dateFormat?: string;
-    /**
-     * Props applied to the `DatePicker`.
-     */
-    datePickerProps?: DatePickerProps;
-    /**
-     * Props applied to the `TimePicker`.
-     */
-    timePickerProps?: TimePickerProps;
-    /**
-     * Function used to parse datetime values into their date, time and timezone sub-values. *
-     */
-    parseValue?: (dateTimeValue: string, date: string, time: string, timezone: string) => {
-        dateValue: string;
-        timeValue: string;
-        zoneValue: string;
-    };
-    /**
-     * [Select props](/components/select) to pass onto the `DatePicker` component's `Select`. This can be used to set options such as placeholder text.
-     */
-    datePickerSelectProps?: SelectProps<any>;
-    /**
-     * [Select props](/components/select) to pass onto the `TimePicker` component's `Select`. This can be used to set options such as placeholder text.
-     */
-    timePickerSelectProps?: SelectProps<any>;
-    /**
-     * The times shown by the `TimePicker`.
-     */
-    times?: Array<string>;
-    /**
-     * The format that times are displayed in. Values should be those accepted by [date-fns's format function](https://date-fns.org/v1.29.0/docs/format).
-     */
-    timeFormat?: string;
-    /**
-     * The spacing for the select control.
-     *
-     * Compact is `gridSize() * 4`, default is `gridSize() * 5`.
-     */
-    spacing?: Spacing;
-    /**
-     * Locale used for formatting dates and times. See [DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat).
-     */
-    locale?: string;
-    /**
-     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
-     *  - `{testId}--datepicker--container` wrapping element of date-picker
-     *  - `{testId}--timepicker--container` wrapping element of time-picker
-     */
-    testId?: string;
-}
-declare type DateTimePickerProps = typeof dateTimePickerDefaultProps & DateTimePickerBaseProps;
-interface State {
-    active: 0 | 1 | 2;
-    dateValue: string;
-    isFocused: boolean;
-    timeValue: string;
-    value: string;
-    zoneValue: string;
-}
-declare const dateTimePickerDefaultProps: {
-    appearance: string;
-    autoFocus: boolean;
-    isDisabled: boolean;
-    name: string;
-    onBlur: (event: React.FocusEvent<HTMLInputElement>) => void;
-    onChange: (value: string) => void;
-    onFocus: (event: React.FocusEvent<HTMLInputElement>) => void;
-    innerProps: {};
-    id: string;
-    defaultValue: string;
-    timeIsEditable: boolean;
-    isInvalid: boolean;
-    datePickerProps: {};
-    timePickerProps: {};
-    datePickerSelectProps: {};
-    timePickerSelectProps: {};
-    times: string[];
-    spacing: string;
-    locale: string;
-};
-declare class DateTimePicker extends React.Component<DateTimePickerProps, State> {
-    static defaultProps: {
-        appearance: string;
-        autoFocus: boolean;
-        isDisabled: boolean;
-        name: string;
-        onBlur: (event: React.FocusEvent<HTMLInputElement>) => void;
-        onChange: (value: string) => void;
-        onFocus: (event: React.FocusEvent<HTMLInputElement>) => void;
-        innerProps: {};
-        id: string;
-        defaultValue: string;
-        timeIsEditable: boolean;
-        isInvalid: boolean;
-        datePickerProps: {};
-        timePickerProps: {};
-        datePickerSelectProps: {};
-        timePickerSelectProps: {};
-        times: string[];
-        spacing: string;
-        locale: string;
-    };
-    state: State;
-    getSafeState: () => {
-        dateValue: string;
-        timeValue: string;
-        zoneValue: string;
-        value: string;
-        active: 0 | 1 | 2;
-        isFocused: boolean;
-    };
-    parseValue(value: string, dateValue: string, timeValue: string, zoneValue: string): {
-        dateValue: string;
-        timeValue: string;
-        zoneValue: string;
-    };
-    onBlur: (event: React.FocusEvent<HTMLInputElement>) => void;
-    onFocus: (event: React.FocusEvent<HTMLInputElement>) => void;
-    onDateChange: (dateValue: string) => void;
-    onTimeChange: (timeValue: string) => void;
-    onClear: () => void;
-    onValueChange({ dateValue, timeValue, zoneValue, }: {
-        dateValue: string;
-        timeValue: string;
-        zoneValue: string;
-    }): void;
-    render(): jsx.JSX.Element;
-}
-export { DateTimePicker as DateTimePickerWithoutAnalytics };
-declare const _default: React.ForwardRefExoticComponent<Pick<Pick<Omit<DateTimePickerProps, keyof WithAnalyticsEventsProps>, "testId" | "value" | "dateFormat" | "timeFormat" | "parseValue"> & Partial<Pick<Omit<DateTimePickerProps, keyof WithAnalyticsEventsProps>, "appearance" | "autoFocus" | "defaultValue" | "id" | "innerProps" | "isDisabled" | "name" | "onBlur" | "onChange" | "onFocus" | "spacing" | "isInvalid" | "locale" | "times" | "timeIsEditable" | "datePickerProps" | "timePickerProps" | "datePickerSelectProps" | "timePickerSelectProps">> & Partial<Pick<{
-    appearance: string;
-    autoFocus: boolean;
-    isDisabled: boolean;
-    name: string;
-    onBlur: (event: React.FocusEvent<HTMLInputElement>) => void;
-    onChange: (value: string) => void;
-    onFocus: (event: React.FocusEvent<HTMLInputElement>) => void;
-    innerProps: {};
-    id: string;
-    defaultValue: string;
-    timeIsEditable: boolean;
-    isInvalid: boolean;
-    datePickerProps: {};
-    timePickerProps: {};
-    datePickerSelectProps: {};
-    timePickerSelectProps: {};
-    times: string[];
-    spacing: string;
-    locale: string;
-}, never>> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "testId" | "appearance" | "autoFocus" | "defaultValue" | "id" | "innerProps" | "isDisabled" | "name" | "onBlur" | "onChange" | "onFocus" | "spacing" | "value" | "isInvalid" | "dateFormat" | "locale" | "key" | "analyticsContext" | "times" | "timeIsEditable" | "timeFormat" | "datePickerProps" | "timePickerProps" | "parseValue" | "datePickerSelectProps" | "timePickerSelectProps"> & React.RefAttributes<any>>;
-export default _default;

package/dist/types-ts4.0/components/time-picker.d.ts

@@ -1,228 +0,0 @@
-import React from 'react';
-import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
-import { LocalizationProvider } from '@atlaskit/locale';
-import { ActionMeta, OptionType, SelectProps } from '@atlaskit/select';
-import { Appearance, Spacing } from '../types';
-interface Option {
-    label: string;
-    value: string;
-}
-export interface TimePickerBaseProps extends WithAnalyticsEventsProps {
-    /**
-     * Set the appearance of the picker.
-     * `subtle` will remove the borders, background, and icon.
-     *
-     * __NOTE:__ Appearance values will be ignored if styles are parsed through `selectProps`.
-     */
-    appearance?: Appearance;
-    /**
-     * Set the picker to autofocus on mount.
-     */
-    autoFocus?: boolean;
-    /**
-     * The default for `isOpen`.
-     */
-    defaultIsOpen?: boolean;
-    /**
-     * The default for `value`.
-     */
-    defaultValue?: string;
-    /**
-     * A function for formatting the displayed time value in the input. By default parses with an internal time parser, and formats using the [date-fns format function]((https://date-fns.org/v1.29.0/docs/format))
-     */
-    formatDisplayLabel?: (time: string, timeFormat: string) => string;
-    /**
-     * The id of the field. Currently, react-select transforms this to have a `react-select-` prefix, and an `--input` suffix when applied to the input. For example, the id `my-input` would be transformed to `react-select-my-input--input`. Keep this in mind when needing to refer to the ID. This will be fixed in an upcoming release.
-     */
-    id?: string;
-    /**
-     * Props to apply to the container. *
-     */
-    innerProps?: React.AllHTMLAttributes<HTMLElement>;
-    /**
-     * Set if the field is disabled.
-     */
-    isDisabled?: boolean;
-    /**
-     * Set if the dropdown is open. Will be `false` if not provided.
-     */
-    isOpen?: boolean;
-    /**
-     * The name of the field.
-     */
-    name?: string;
-    /**
-     * Called when the field is blurred.
-     */
-    onBlur?: React.FocusEventHandler<HTMLElement>;
-    /**
-     * Called when the value changes. The only argument is an ISO time or empty string.
-     */
-    onChange?: (value: string) => void;
-    /**
-     * Called when the field is focused.
-     */
-    onFocus?: React.FocusEventHandler<HTMLElement>;
-    parseInputValue?: (time: string, timeFormat: string) => string | Date;
-    /**
-     * Props to apply to the select.
-     */
-    selectProps?: SelectProps<any>;
-    /**
-     * The spacing for the select control.
-     *
-     * Compact is `gridSize() * 4`, default is `gridSize * 5`.
-     */
-    spacing?: Spacing;
-    /**
-     * The times shown in the dropdown.
-     */
-    times?: string[];
-    /**
-     * Set if users can edit the input, allowing them to add custom times.
-     */
-    timeIsEditable?: boolean;
-    /**
-     * The ISO time that should be used as the input value.
-     */
-    value?: string;
-    /**
-     * Set if the picker has an invalid value.
-     */
-    isInvalid?: boolean;
-    /**
-     * Hides icon for dropdown indicator.
-     */
-    hideIcon?: boolean;
-    /**
-     * Time format that is accepted by [date-fns's format function](https://date-fns.org/v1.29.0/docs/format).
-     */
-    timeFormat?: string;
-    /**
-     * Placeholder text displayed in input.
-     */
-    placeholder?: string;
-    /**
-     * Locale used to format the time. See [DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat).
-     */
-    locale?: string;
-    /**
-     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests:
-     *  - `{testId}--container` wrapping element of time-picker
-     */
-    testId?: string;
-}
-declare type TimePickerProps = typeof timePickerDefaultProps & TimePickerBaseProps;
-interface State {
-    isOpen: boolean;
-    /**
-     * When being cleared from the icon the TimePicker is blurred.
-     * This variable defines whether the default onMenuOpen or onMenuClose
-     * events should behave as normal
-     */
-    clearingFromIcon: boolean;
-    value: string;
-    isFocused: boolean;
-    l10n: LocalizationProvider;
-}
-declare const timePickerDefaultProps: {
-    appearance: Appearance;
-    autoFocus: boolean;
-    defaultIsOpen: boolean;
-    defaultValue: string;
-    hideIcon: boolean;
-    id: string;
-    innerProps: {};
-    isDisabled: boolean;
-    isInvalid: boolean;
-    name: string;
-    onBlur: (event: React.FocusEvent<HTMLInputElement>) => void;
-    onChange: (value: string) => void;
-    onFocus: (event: React.FocusEvent<HTMLInputElement>) => void;
-    parseInputValue: (time: string, timeFormat: string) => string | Date;
-    selectProps: {};
-    spacing: Spacing;
-    times: string[];
-    timeIsEditable: boolean;
-    locale: string;
-};
-declare class TimePicker extends React.Component<TimePickerProps, State> {
-    containerRef: HTMLElement | null;
-    static defaultProps: {
-        appearance: Appearance;
-        autoFocus: boolean;
-        defaultIsOpen: boolean;
-        defaultValue: string;
-        hideIcon: boolean;
-        id: string;
-        innerProps: {};
-        isDisabled: boolean;
-        isInvalid: boolean;
-        name: string;
-        onBlur: (event: React.FocusEvent<HTMLInputElement>) => void;
-        onChange: (value: string) => void;
-        onFocus: (event: React.FocusEvent<HTMLInputElement>) => void;
-        parseInputValue: (time: string, timeFormat: string) => string | Date;
-        selectProps: {};
-        spacing: Spacing;
-        times: string[];
-        timeIsEditable: boolean;
-        locale: string;
-    };
-    state: {
-        isOpen: boolean;
-        clearingFromIcon: boolean;
-        value: string;
-        isFocused: boolean;
-        l10n: LocalizationProvider;
-    };
-    UNSAFE_componentWillReceiveProps(nextProps: TimePickerProps): void;
-    getSafeState: () => State;
-    getOptions(): Array<Option>;
-    onChange: (v: {
-        value: string;
-    } | null, action?: ActionMeta<OptionType> | undefined) => void;
-    /**
-     * Only allow custom times if timeIsEditable prop is true
-     */
-    onCreateOption: (inputValue: any) => void;
-    onMenuOpen: () => void;
-    onMenuClose: () => void;
-    setContainerRef: (ref: HTMLElement | null) => void;
-    onBlur: (event: React.FocusEvent<HTMLElement>) => void;
-    onFocus: (event: React.FocusEvent<HTMLElement>) => void;
-    onSelectKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
-    /**
-     * There are multiple props that can change how the time is formatted.
-     * The priority of props used is:
-     *   1. formatDisplayLabel
-     *   2. timeFormat
-     *   3. locale
-     */
-    formatTime: (time: string) => string;
-    getPlaceholder: () => string;
-    render(): JSX.Element;
-}
-export { TimePicker as TimePickerWithoutAnalytics };
-declare const _default: React.ForwardRefExoticComponent<Pick<Pick<Omit<TimePickerProps, keyof WithAnalyticsEventsProps>, "testId" | "isOpen" | "formatDisplayLabel" | "value" | "placeholder" | "timeFormat"> & Partial<Pick<Omit<TimePickerProps, keyof WithAnalyticsEventsProps>, "appearance" | "autoFocus" | "defaultIsOpen" | "defaultValue" | "id" | "innerProps" | "isDisabled" | "name" | "onBlur" | "onChange" | "onFocus" | "parseInputValue" | "selectProps" | "spacing" | "isInvalid" | "hideIcon" | "locale" | "times" | "timeIsEditable">> & Partial<Pick<{
-    appearance: Appearance;
-    autoFocus: boolean;
-    defaultIsOpen: boolean;
-    defaultValue: string;
-    hideIcon: boolean;
-    id: string;
-    innerProps: {};
-    isDisabled: boolean;
-    isInvalid: boolean;
-    name: string;
-    onBlur: (event: React.FocusEvent<HTMLInputElement>) => void;
-    onChange: (value: string) => void;
-    onFocus: (event: React.FocusEvent<HTMLInputElement>) => void;
-    parseInputValue: (time: string, timeFormat: string) => string | Date;
-    selectProps: {};
-    spacing: Spacing;
-    times: string[];
-    timeIsEditable: boolean;
-    locale: string;
-}, never>> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "testId" | "appearance" | "autoFocus" | "defaultIsOpen" | "defaultValue" | "id" | "innerProps" | "isDisabled" | "isOpen" | "name" | "onBlur" | "onChange" | "onFocus" | "parseInputValue" | "formatDisplayLabel" | "selectProps" | "spacing" | "value" | "isInvalid" | "hideIcon" | "placeholder" | "locale" | "key" | "analyticsContext" | "times" | "timeIsEditable" | "timeFormat"> & React.RefAttributes<any>>;
-export default _default;

package/dist/types-ts4.0/components/utils.d.ts

@@ -1 +0,0 @@
-export declare function convertTokens(format: string): string;

package/dist/types-ts4.0/index.d.ts

@@ -1,7 +0,0 @@
-export { default as DatePicker } from './components/date-picker';
-export type { DatePickerBaseProps as DatePickerProps } from './components/date-picker';
-export { default as TimePicker } from './components/time-picker';
-export type { TimePickerBaseProps as TimePickerProps } from './components/time-picker';
-export { default as DateTimePicker } from './components/date-time-picker';
-export type { DateTimePickerBaseProps as DateTimePickerProps } from './components/date-time-picker';
-export type { Appearance, Spacing } from './types';

package/dist/types-ts4.0/internal/fixed-layer.d.ts

@@ -1,33 +0,0 @@
-import React from 'react';
-interface FixedLayerProps {
-    /**
-     * A ref to the container that the content should be layered around for height calculation
-     * purposes. This must be an ancestor element as component does not attach the layered content around
-     * the ref itself.
-     */
-    containerRef: HTMLElement | null;
-    /**
-     * The content to render in the layer.
-     */
-    content: React.ReactNode;
-    /**
-     * input value from the menu.
-     */
-    inputValue: string;
-    /**
-     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
-     *  - `{testId}--popper-container` wrapping element of time-picker
-     */
-    testId?: string;
-}
-/**
- * This component renders layered content with fixed positioning.
- * Scroll is locked outside the layer to prevent the layered content from detaching from the
- * container ref.
- */
-export default class FixedLayer extends React.Component<FixedLayerProps> {
-    update: () => void;
-    componentDidUpdate(prevProps: any): void;
-    render(): JSX.Element;
-}
-export {};

package/dist/types-ts4.0/internal/index.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-import { IndicatorProps } from '@atlaskit/select';
-export declare const EmptyClearIndicator: null;
-export declare const placeholderDatetime: Date;
-export declare const defaultTimes: string[];
-export declare const defaultTimeFormat = "h:mma";
-export declare const defaultDateFormat = "YYYY/MM/DD";
-export declare function padToTwo(number: number): string;
-export declare const DropdownIndicator: (props: IndicatorProps<any>) => JSX.Element | null;
-export declare function formatDateTimeZoneIntoIso(date: string, time: string, zone: string): string;

package/dist/types-ts4.0/internal/parse-time.d.ts

@@ -1,14 +0,0 @@
-export declare function isValid(timeString: string): boolean;
-export declare function removeSpacer(time: string): string;
-export declare function formatSemi24(time: string): string;
-export declare function checkHour(hour: string, meridiem: string): string | null;
-export declare function checkMinute(minute: string): string | null;
-export declare function convertTo24hrTime(time: string): {
-    hour: number;
-    minute: number;
-} | null;
-export declare function assignToDate(time: {
-    hour: number;
-    minute: number;
-}): Date;
-export default function (time: string): string | Date;

package/dist/types-ts4.0/types.d.ts

@@ -1,3 +0,0 @@
-export declare type Appearance = 'default' | 'subtle' | 'none';
-export declare type Spacing = 'compact' | 'default';
-export declare type SelectProps = any;