23 lines
796 B
JavaScript
23 lines
796 B
JavaScript
import { DateLib } from "../classes/DateLib.js";
|
|
/**
|
|
* Generates the ARIA label for the month grid, which is announced when entering
|
|
* the grid.
|
|
*
|
|
* @defaultValue Locale-specific month/year order (e.g., "November 2022").
|
|
* @param date - The date representing the month.
|
|
* @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 month grid.
|
|
* @group Labels
|
|
* @see https://daypicker.dev/docs/translation#aria-labels
|
|
*/
|
|
export function labelGrid(date, options, dateLib) {
|
|
const lib = dateLib ?? new DateLib(options);
|
|
return lib.formatMonthYear(date);
|
|
}
|
|
/**
|
|
* @ignore
|
|
* @deprecated Use {@link labelGrid} instead.
|
|
*/
|
|
export const labelCaption = labelGrid;
|