24 lines
976 B
TypeScript
24 lines
976 B
TypeScript
import { DateLib, type DateLibOptions } from "../classes/DateLib.js";
|
|
import type { Modifiers } from "../types/index.js";
|
|
/**
|
|
* Generates the ARIA label for a day button.
|
|
*
|
|
* Use the `modifiers` argument to provide additional context for the label,
|
|
* such as indicating if the day is "today" or "selected."
|
|
*
|
|
* @defaultValue The formatted date.
|
|
* @param date - The date to format.
|
|
* @param modifiers - The modifiers providing context for the day.
|
|
* @param options - Optional configuration for the date formatting library.
|
|
* @param dateLib - An optional instance of the date formatting library.
|
|
* @returns The ARIA label for the day button.
|
|
* @group Labels
|
|
* @see https://daypicker.dev/docs/translation#aria-labels
|
|
*/
|
|
export declare function labelDayButton(date: Date, modifiers: Modifiers, options?: DateLibOptions, dateLib?: DateLib): string;
|
|
/**
|
|
* @ignore
|
|
* @deprecated Use `labelDayButton` instead.
|
|
*/
|
|
export declare const labelDay: typeof labelDayButton;
|