@yamada-ui/calendar/dist/use-year-picker.d.mts

Yamada UI calendar component

import * as _yamada_ui_popover from '@yamada-ui/popover';
import * as _yamada_ui_core from '@yamada-ui/core';
import { PropGetter } from '@yamada-ui/core';
import { CalendarProps as CalendarProps$1 } from './calendar.mjs';
import { UseCalendarProps } from './use-calendar.mjs';
import { UseCalendarPickerProps } from './use-calendar-picker.mjs';
import 'react';
import './calendar-header.mjs';
import '@yamada-ui/button';
import '@yamada-ui/icon';
import './use-calendar-header.mjs';
import './month.mjs';
import './month-list.mjs';
import './year-list.mjs';
import 'dayjs';
import '@yamada-ui/form-control';

interface CalendarProps extends Pick<UseCalendarProps<Date | undefined>, "defaultValue" | "locale" | "maxDate" | "minDate" | "onChange" | "value" | "withControls" | "withHeader" | "withLabel" | "yearFormat"> {
}
interface UseYearPickerOptions {
    /**
     * If `true`, the calendar component will be closed when value is selected.
     *
     * @default true
     */
    closeOnSelect?: boolean;
    /**
     * The format used for conversion.
     * Check the docs to see the format of possible modifiers you can pass.
     *
     * @see Docs https://day.js.org/docs/en/display/format#list-of-localized-formats
     * @default 'YYYY'
     */
    inputFormat?: string;
}
interface UseYearPickerProps extends UseCalendarPickerProps<CalendarProps>, UseYearPickerOptions {
}
declare const useYearPicker: ({ closeOnSelect, defaultValue, placeholder, value: valueProp, onChange: onChangeProp, ...rest }: UseYearPickerProps) => {
    value: Date | undefined;
    getCalendarProps: (props?: CalendarProps$1) => CalendarProps$1;
    getContainerProps: PropGetter<"div", undefined>;
    getFieldProps: PropGetter<"div", undefined>;
    getIconProps: _yamada_ui_core.RequiredPropGetter<{
        clear: boolean;
    } & _yamada_ui_core.HTMLProps, _yamada_ui_core.HTMLProps>;
    getInputProps: PropGetter<"input", undefined>;
    getPopoverProps: (props?: _yamada_ui_popover.PopoverProps) => _yamada_ui_popover.PopoverProps;
    onClose: (...args: any[]) => Promise<void> | void;
};
type UseYearPickerReturn = ReturnType<typeof useYearPicker>;

export { type UseYearPickerProps, type UseYearPickerReturn, useYearPicker };