Skip to content

fix: format week number with numerals #2756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/DayPicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -531,7 +531,7 @@ export function DayPicker(initialProps: DayPickerProps) {
scope="row"
role="rowheader"
>
{formatWeekNumber(week.weekNumber)}
{formatWeekNumber(week.weekNumber, dateLib)}
</components.WeekNumber>
)}
{week.days.map((day: CalendarDay) => {
Expand Down
2 changes: 1 addition & 1 deletion src/classes/DateLib.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ export class DateLib {
* @param value The number to format.
* @returns The formatted number.
*/
formatNumber(value: number): string {
formatNumber(value: number | string): string {
return this.replaceDigits(value.toString());
}

Expand Down
11 changes: 11 additions & 0 deletions src/formatters/formatWeekNumber.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
import { DateLib } from "../classes";

import { formatWeekNumber } from "./formatWeekNumber";

test("should return the formatted week number", () => {
expect(formatWeekNumber(10)).toEqual("10");
});

test("should return the formatted week number with leading zero", () => {
expect(formatWeekNumber(1)).toEqual("01");
});

test("should format with the provided numeral system", () => {
const dateLib = new DateLib({ numerals: "arab" });
expect(formatWeekNumber(1, dateLib)).toEqual("٠١");
});
8 changes: 5 additions & 3 deletions src/formatters/formatWeekNumber.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import { defaultDateLib } from "../classes/DateLib.js";

/**
* Format the week number.
*
* @defaultValue `weekNumber.toLocaleString()` with a leading zero for single-digit numbers
* @group Formatters
* @see https://daypicker.dev/docs/translation#custom-formatters
*/
export function formatWeekNumber(weekNumber: number) {
export function formatWeekNumber(weekNumber: number, dateLib = defaultDateLib) {
if (weekNumber < 10) {
return `0${weekNumber.toLocaleString()}`;
return dateLib.formatNumber(`0${weekNumber.toLocaleString()}`);
}
return `${weekNumber.toLocaleString()}`;
return dateLib.formatNumber(`${weekNumber.toLocaleString()}`);
}