@awsui/components-react/calendar/interfaces.d.ts

On July 19th, 2022, we launched [Cloudscape Design System](https://cloudscape.design). Cloudscape is an evolution of AWS-UI. It consists of user interface guidelines, front-end components, design resources, and development tools for building intuitive, en

import { BaseComponentProps } from '../internal/base-component';
import { NonCancelableEventHandler } from '../internal/events';
export interface CalendarProps extends BaseComponentProps {
    /**
     * The current input value, in YYYY-MM-DD format.
     */
    value: string;
    /**
     * Defines whether a particular date is enabled in the calendar or not.
     * If you disable a date in the calendar, users can still enter this date using a keyboard.
     * We recommend that you also validate these constraints on the client-side and server-side
     * as you would for other form elements.
     * @param date
     */
    isDateEnabled?: CalendarProps.IsDateEnabledFunction;
    /**
     * Provides a reason why a particular date in the calendar is not enabled (only when `isDateEnabled` returns `false`).
     * If provided, the date becomes focusable.
     * @param date
     */
    dateDisabledReason?: CalendarProps.DateDisabledReasonFunction;
    /**
     * Specifies the locale to use to render month names and determine the starting day of the week.
     * If you don't provide this, the locale is determined by the page and browser locales.
     * Supported values and formats are listed in the
     * [JavaScript Intl API specification](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation).
     */
    locale?: string;
    /**
     * Determines the starting day of the week. The values 0-6 map to Sunday-Saturday.
     * By default the starting day of the week is defined by the locale, but you can use this property to override it.
     */
    startOfWeek?: number;
    /**
     * Adds an `aria-label` to the calendar.
     */
    ariaLabel?: string;
    /**
     * Adds `aria-labelledby` to the calendar.
     */
    ariaLabelledby?: string;
    /**
     * Adds `aria-describedby` to the calendar.
     */
    ariaDescribedby?: string;
    /**
     * Used as part of the `aria-label` for today's date in the calendar.
     * @deprecated Use `i18nString.todayAriaLabel` instead.
     */
    todayAriaLabel?: string;
    /**
     * Specifies an `aria-label` for the 'next month' button.
     * @deprecated Use `i18nStrings.nextMonthAriaLabel` instead.
     */
    nextMonthAriaLabel?: string;
    /**
     * Specifies an `aria-label` for the 'previous month' button.
     * @deprecated Use `i18nStrings.previousMonthAriaLabel` instead.
     */
    previousMonthAriaLabel?: string;
    /**
     * Called whenever a user changes the input value (by typing, pasting, or selecting a value).
     * The event `detail` contains the current value of the field.
     */
    onChange?: NonCancelableEventHandler<CalendarProps.ChangeDetail>;
    /**
     * An object containing all the necessary localized strings required by
     * the component.
     * @i18n
     */
    i18nStrings?: CalendarProps.I18nStrings;
    /**
     * Specifies the granularity at which users will be able to select a date.
     * Defaults to `day`.
     **/
    granularity?: CalendarProps.Granularity;
}
export declare namespace CalendarProps {
    interface ChangeDetail {
        /**
         * The new value of this component.
         */
        value: string;
    }
    interface IsDateEnabledFunction {
        (date: Date): boolean;
    }
    interface DateDisabledReasonFunction {
        (date: Date): string;
    }
    type Granularity = 'day' | 'month';
    interface I18nStrings {
        /**
         * Used as part of the `aria-label` for today's date in the calendar.
         */
        todayAriaLabel?: string;
        /**
         * Specifies an `aria-label` for the 'next month' button.
         */
        nextMonthAriaLabel?: string;
        /**
         * Specifies an `aria-label` for the 'previous month' button.
         */
        previousMonthAriaLabel?: string;
        /**
         * Used as part of the `aria-label` for the current month in the calendar.
         * @i18n
         */
        currentMonthAriaLabel?: string;
        /**
         * Specifies an `aria-label` for the 'next year' button.
         * @i18n
         */
        nextYearAriaLabel?: string;
        /**
         * Specifies an `aria-label` for the 'previous year' button.
         * @i18n
         */
        previousYearAriaLabel?: string;
    }
}
//# sourceMappingURL=interfaces.d.ts.map