Update documentation for calendar

This commit is contained in:
Takahito Yamatoya
2020-10-21 04:55:29 +09:00
committed by GitHub
parent 3941fd81ab
commit b52056ee49

View File

@ -13,6 +13,7 @@ To render a calendar, create a `Calendar` instance with a target date.
var calendar = new Calendar(2020,10); var calendar = new Calendar(2020,10);
AnsiConsole.Render(calendar); AnsiConsole.Render(calendar);
2020 October
┌─────┬─────┬─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┐
Sun Mon Tue Wed Thu Fri Sat Sun Mon Tue Wed Thu Fri Sat
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
@ -23,7 +24,6 @@ AnsiConsole.Render(calendar);
25 26 27 28 29 30 31 25 26 27 28 29 30 31
└─────┴─────┴─────┴─────┴─────┴─────┴─────┘ └─────┴─────┴─────┴─────┴─────┴─────┴─────┘
``` ```
## Culture ## Culture
@ -35,6 +35,7 @@ var calendar = new Calendar(2020,10);
calendar.SetCulture("ja-JP"); calendar.SetCulture("ja-JP");
AnsiConsole.Render(calendar); AnsiConsole.Render(calendar);
202010
┌────┬────┬────┬────┬────┬────┬────┐ ┌────┬────┬────┬────┬────┬────┬────┐
├────┼────┼────┼────┼────┼────┼────┤ ├────┼────┼────┼────┼────┼────┼────┤
@ -45,9 +46,38 @@ AnsiConsole.Render(calendar);
25 26 27 28 29 30 31 25 26 27 28 29 30 31
└────┴────┴────┴────┴────┴────┴────┘ └────┴────┴────┴────┴────┴────┴────┘
``` ```
## Header
You can hide the calendar header.
```csharp
var calendar = new Calendar(2020,10);
calendar.ShowHeader = false;
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
└─────┴─────┴─────┴─────┴─────┴─────┴─────┘
```
You can set the header style of the calendar.
```csharp
var calendar = new Calendar(2020,10);
calendar.SetHeaderStyle(Style.Parse("blue bold"));
AnsiConsole.Render(calendar);
```
## Calendar Event ## Calendar Event
You can add an event to the calendar. You can add an event to the calendar.
@ -58,6 +88,7 @@ var calendar = new Calendar(2020,10);
calendar.AddCalendarEvent(2020, 10, 11); calendar.AddCalendarEvent(2020, 10, 11);
AnsiConsole.Render(calendar); AnsiConsole.Render(calendar);
2020 October
┌─────┬─────┬─────┬─────┬─────┬─────┬─────┐ ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┐
Sun Mon Tue Wed Thu Fri Sat Sun Mon Tue Wed Thu Fri Sat
├─────┼─────┼─────┼─────┼─────┼─────┼─────┤ ├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
@ -68,7 +99,6 @@ AnsiConsole.Render(calendar);
25 26 27 28 29 30 31 25 26 27 28 29 30 31
└─────┴─────┴─────┴─────┴─────┴─────┴─────┘ └─────┴─────┴─────┴─────┴─────┴─────┴─────┘
``` ```
### Highlight style ### Highlight style