Add documentation for calendar

2025-10-31 09:09:25 +08:00 · 2020-10-19 22:44:16 +09:00
parent b9d182b6e3
commit 5c119ee0c3
1 changed files with 83 additions and 0 deletions
--- a/docs/input/appendix/calendar.md
+++ b/docs/input/appendix/calendar.md
@@ -0,0 +1,83 @@
+Title: Calendar
+Order: 4
+---
+
+The `Calendar` is used to render a calendar to the terminal.
+
+# Usage
+
+To render a calendar, create a `Calendar` instance with a target date.
+
+```csharp
+var calendar = new Calendar(2020,10);
+AnsiConsole.Render(calendar);
+
+┌─────┬─────┬─────┬─────┬─────┬─────┬─────┐
+│ Sun │ Mon │ Tue │ Wed │ Thu │ Fri │ Sat │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│     │     │     │     │ 1   │ 2   │ 3   │
+│ 4   │ 5   │ 6   │ 7   │ 8   │ 9   │ 10  │
+│ 11  │ 12  │ 13  │ 14  │ 15  │ 16  │ 17  │
+│ 18  │ 19  │ 20  │ 21  │ 22  │ 23  │ 24  │
+│ 25  │ 26  │ 27  │ 28  │ 29  │ 30  │ 31  │
+│     │     │     │     │     │     │     │
+└─────┴─────┴─────┴─────┴─────┴─────┴─────┘
+
+```
+
+## Culture
+
+You can set the calendar's culture to show localized weekdays.
+
+```csharp
+var calendar = new Calendar(2020,10);
+calendar.SetCulture("ja-JP");
+AnsiConsole.Render(calendar);
+
+┌────┬────┬────┬────┬────┬────┬────┐
+│ 日 │ 月 │ 火 │ 水 │ 木 │ 金 │ 土 │
+├────┼────┼────┼────┼────┼────┼────┤
+│    │    │    │    │ 1  │ 2  │ 3  │
+│ 4  │ 5  │ 6  │ 7  │ 8  │ 9  │ 10 │
+│ 11 │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 │
+│ 18 │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 │
+│ 25 │ 26 │ 27 │ 28 │ 29 │ 30 │ 31 │
+│    │    │    │    │    │    │    │
+└────┴────┴────┴────┴────┴────┴────┘
+
+```
+
+## Calendar Event
+
+You can add an event to the calendar.
+If a date has an event associated with it, the date gets highlighted in the calendar.
+
+```csharp
+var calendar = new Calendar(2020,10);
+calendar.AddCalendarEvent(2020, 10, 11);
+AnsiConsole.Render(calendar);
+
+┌─────┬─────┬─────┬─────┬─────┬─────┬─────┐
+│ Sun │ Mon │ Tue │ Wed │ Thu │ Fri │ Sat │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│     │     │     │     │ 1   │ 2   │ 3   │
+│ 4   │ 5   │ 6   │ 7   │ 8   │ 9   │ 10  │
+│ 11* │ 12  │ 13  │ 14  │ 15  │ 16  │ 17  │
+│ 18  │ 19  │ 20  │ 21  │ 22  │ 23  │ 24  │
+│ 25  │ 26  │ 27  │ 28  │ 29  │ 30  │ 31  │
+│     │     │     │     │     │     │     │
+└─────┴─────┴─────┴─────┴─────┴─────┴─────┘
+
+```
+
+### Highlight style
+
+You can set the highlight style for a calendar event via `SetHighlightStyle`.
+
+```csharp
+var calendar = new Calendar(2020,10);
+calendar.AddCalendarEvent(2020, 10, 11);
+calendar.SetHighlightStyle(Style.Parse("yellow bold"));
+AnsiConsole.Render(calendar);
+
+```