33 lines
1.2 KiB
TypeScript
33 lines
1.2 KiB
TypeScript
import React, { type SelectHTMLAttributes } from "react";
|
|
import type { ClassNames, CustomComponents } from "../types/index.js";
|
|
/** An option to use in the dropdown. Maps to the `<option>` HTML element. */
|
|
export type DropdownOption = {
|
|
/** The value of the option. */
|
|
value: number;
|
|
/** The label of the option. */
|
|
label: string;
|
|
/** Whether the dropdown option is disabled (e.g., out of the calendar range). */
|
|
disabled: boolean;
|
|
};
|
|
/**
|
|
* Render a dropdown component for navigation in the calendar.
|
|
*
|
|
* @group Components
|
|
* @see https://daypicker.dev/guides/custom-components
|
|
*/
|
|
export declare function Dropdown(props: {
|
|
/**
|
|
* @deprecated Use {@link useDayPicker} hook to get the list of internal
|
|
* components.
|
|
*/
|
|
components: CustomComponents;
|
|
/**
|
|
* @deprecated Use {@link useDayPicker} hook to get the list of internal
|
|
* class names.
|
|
*/
|
|
classNames: ClassNames;
|
|
/** The options to display in the dropdown. */
|
|
options?: DropdownOption[] | undefined;
|
|
} & Omit<SelectHTMLAttributes<HTMLSelectElement>, "children">): React.JSX.Element;
|
|
export type DropdownProps = Parameters<typeof Dropdown>[0];
|