Skip to content
This repository was archived by the owner on Mar 4, 2023. It is now read-only.

Commit 2f8a1bf

Browse files
author
eksrvb
committed
more docs
1 parent ffdf093 commit 2f8a1bf

File tree

2 files changed

+9
-25
lines changed

2 files changed

+9
-25
lines changed

docs/api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ Optionally provide your location:
5151

5252
| Name | Default | Description |
5353
| ---- | ------- | ----------- |
54-
| placeholderDay: boolean | false | |
55-
| dataSource: DayC[] | null | |
56-
| year: number | current year | |
57-
| month: number | current month | |
58-
| monthsBefore: number | 0 | |
59-
| monthsAfter: number | 0 | |
60-
| config: CalendarConfig | null | |
61-
| (clickDate) | - | |
54+
| placeholderDay: boolean | false | show a day that does not occur directly in the month and serves as a visual placeholder |
55+
| dataSource: DayC[] | null | transfer own days to equip the existing days in the component with data |
56+
| year: number | current year | select the start year |
57+
| month: number | current month | select the start month |
58+
| monthsBefore: number | 0 | how many months should be displayed before the selected month |
59+
| monthsAfter: number | 0 | how many months should be displayed after the selected month |
60+
| config: CalendarConfig | null | overwrite configuration for the component |
61+
| (clickDate) | - | returns an event with selected days depending on the selected mode (single click or range of days) |
6262

6363
## interfaces
6464

docs/examples.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -95,20 +95,4 @@ calendarConfig: CalendarConfig = {
9595
markWeekend: true,
9696
panelWidth: '350px'
9797
};
98-
```
99-
100-
The interface for CalendarConfig:
101-
102-
```typescript
103-
/**
104-
* @param {string} renderMode choose render mode ('annual' or 'monthly')
105-
* @param {string} selectMode choose select mode ('click' or 'range')
106-
* @param {boolean} calendarWeek display the calendar week
107-
* @param {boolean} displayYear displays the year next to the Month name
108-
* @param {boolean} switches show arrows to navigate an month forward or backwards
109-
* @param {boolean} bluredDays make an circle around the number of the day
110-
* @param {boolean} markWeekend highlight weekends
111-
* @param {boolean} firstDayOfWeekMonday set first day of week (monday or sunday)
112-
* @param {string} panelWidth set a with for an single panel
113-
*/
114-
```
98+
```

0 commit comments

Comments
 (0)