Skip to main content

Function: formatWeekdayName()

formatWeekdayName(weekday, options?, dateLib?): string

Defined in: src/formatters/formatWeekdayName.ts:15

Formats the name of a weekday to be displayed in the weekdays header.

Parameters

ParameterTypeDescription
weekdayDateThe date representing the weekday.
options?DateLibOptionsConfiguration options for the date library.
dateLib?DateLibThe date library to use for formatting. If not provided, a new instance is created.

Returns

string

The formatted weekday name as a string.

Default Value

cccccc (e.g., "Mo" for Monday).

See

https://daypicker.dev/docs/translation#custom-formatters