Skip to content

Commit d9654ec

Browse files
FamousWolfFamousWolf
authored
Merge pull request #104 from FamousWolf/dev
[RELEASE] Version 1.6.0
2 parents 449b1f7 + b5ffe03 commit d9654ec

File tree

4 files changed

+1202
-377
lines changed

4 files changed

+1202
-377
lines changed

‎README.md

Lines changed: 46 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Custom Home Assistant card displaying a responsive overview of multiple days wit
3939
Add:
4040
```yaml
4141
resources:
42-
- url: /local/week-planner-card.js?version=1.5.1
42+
- url: /local/week-planner-card.js?version=1.6.0
4343
type: module
4444
```
4545
- **Using the graphical editor**
@@ -53,26 +53,28 @@ Custom Home Assistant card displaying a responsive overview of multiple days wit
5353

5454
### Main Options
5555

56-
| Name | Type | Default | Supported options | Description | Version |
57-
|-------------------------|------------------|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|---------|
58-
| `type` | string | **Required** | `custom:week-planner-card` | Type of the card | 1.0.0 |
59-
| `days` | number \| string | 7 | Any positive integer number \| `month` | The number of days to show | 1.0.0 |
60-
| `startingDay` | string | `today` | `today` \| `tomorrow` \| `yesterday` \| `sunday` \| `monday` \| `tuesday` \| `wednesday` \| `thursday` \| `friday` \| `saturday` \| `month` | Day to start with | 1.2.0 |
61-
| `hideWeekend` | boolean | false | `false` \| `true` | Do not show Saturday and Sunday | 1.2.0 |
62-
| `noCardBackground` | boolean | false | `false` \| `true` | Do not show default card background and border | 1.0.0 |
63-
| `eventBackground` | string | `var(--card-background-color, inherit)` | Any CSS color | Background color of the events | 1.0.0 |
64-
| `compact` | boolean | false | `false` \| `true` | Use compact mode, decreasing several spacings and font sizes | 1.2.0 |
65-
| `updateInterval` | number | 60 | Any positive integer number | Seconds between checks for new events | 1.0.0 |
66-
| `calendars` | object list | **Required** | See [Calendars](#calendars) | Calendars shown in this card | 1.0.0 |
67-
| `texts` | object list | {} | See [Texts](#texts) | Texts used in the card | 1.0.0 |
68-
| `weather` | object | optional | See [Weather](#weather) | Configuration for optional weather forecast | 1.1.0 |
69-
| `dateFormat` | string | `cccc d LLLL yyyy` | See [Luxon format](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) | Format of the date in event details | 1.0.0 |
70-
| `timeFormat` | string | `HH:mm` | See [Luxon format](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) | Format of the time | 1.0.0 |
71-
| `locale` | string | `en` | Any locale string supported by Luxon | Locale used for day and month texts | 1.1.0 |
72-
| `locationLink` | string | `https://www.google.com/maps/search/?api=1&query=` | Any URL | Link used for event location in the detail popup | 1.1.0 |
73-
| `showLocation` | boolean | false | `false` \| `true` | Show event location in overview | 1.3.0 |
74-
| `hidePastEvents` | boolean | false | `false` \| `true` | Do not show past events | 1.3.0 |
75-
| `hideDaysWithoutEvents` | boolean | false | `false` \| `true` | Do not show days without events, except for today | 1.4.0 |
56+
| Name | Type | Default | Supported options | Description | Version |
57+
|-------------------------|------------------|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|---------|
58+
| `type` | string | **Required** | `custom:week-planner-card` | Type of the card | 1.0.0 |
59+
| `title` | string | optional | Any string | Card title | 1.6.0 |
60+
| `days` | number \| string | 7 | Any positive integer number \| `month` | The number of days to show | 1.0.0 |
61+
| `startingDay` | string | `today` | `today` \| `tomorrow` \| `yesterday` \| `sunday` \| `monday` \| `tuesday` \| `wednesday` \| `thursday` \| `friday` \| `saturday` \| `month` | Day to start with | 1.2.0 |
62+
| `hideWeekend` | boolean | false | `false` \| `true` | Do not show Saturday and Sunday | 1.2.0 |
63+
| `noCardBackground` | boolean | false | `false` \| `true` | Do not show default card background and border | 1.0.0 |
64+
| `eventBackground` | string | `var(--card-background-color, inherit)` | Any CSS color | Background color of the events | 1.0.0 |
65+
| `compact` | boolean | false | `false` \| `true` | Use compact mode, decreasing several spacings and font sizes | 1.2.0 |
66+
| `updateInterval` | number | 60 | Any positive integer number | Seconds between checks for new events | 1.0.0 |
67+
| `calendars` | object list | **Required** | See [Calendars](#calendars) | Calendars shown in this card | 1.0.0 |
68+
| `texts` | object list | {} | See [Texts](#texts) | Texts used in the card | 1.0.0 |
69+
| `weather` | object | optional | See [Weather](#weather) | Configuration for optional weather forecast | 1.1.0 |
70+
| `dayFormat` | string | optional | See [Luxon format](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) | Format of the date at the top of the day. This is not escaped, so HTML is allowed here | 1.6.0 |
71+
| `dateFormat` | string | `cccc d LLLL yyyy` | See [Luxon format](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) | Format of the date in event details | 1.0.0 |
72+
| `timeFormat` | string | `HH:mm` | See [Luxon format](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) | Format of the time | 1.0.0 |
73+
| `locale` | string | `en` | Any locale string supported by Luxon | Locale used for day and month texts | 1.1.0 |
74+
| `locationLink` | string | `https://www.google.com/maps/search/?api=1&query=` | Any URL | Link used for event location in the detail popup | 1.1.0 |
75+
| `showLocation` | boolean | false | `false` \| `true` | Show event location in overview | 1.3.0 |
76+
| `hidePastEvents` | boolean | false | `false` \| `true` | Do not show past events | 1.3.0 |
77+
| `hideDaysWithoutEvents` | boolean | false | `false` \| `true` | Do not show days without events, except for today | 1.4.0 |
7678

7779
### Calendars
7880

@@ -113,13 +115,20 @@ Like with most cards, you can add custom styling to this card using [card_mod](h
113115

114116
### Day classes
115117

116-
| Class | Description | Version |
117-
|-------------|-------------------|---------|
118-
| `today` | The current day | 1.5.0 |
119-
| `tomorrow` | The next day | 1.5.0 |
120-
| `yesterday` | The previous day | 1.5.0 |
121-
| `future` | Day in the future | 1.5.0 |
122-
| `past` | Day in the past | 1.5.0 |
118+
| Class | Description | Version |
119+
|-------------|--------------------|---------|
120+
| `today` | The current day | 1.5.0 |
121+
| `tomorrow` | The next day | 1.5.0 |
122+
| `yesterday` | The previous day | 1.5.0 |
123+
| `future` | Day in the future | 1.5.0 |
124+
| `past` | Day in the past | 1.5.0 |
125+
| `sunday` | Day is a sunday | 1.6.0 |
126+
| `monday` | Day is a monday | 1.6.0 |
127+
| `tuesday` | Day is a tuesday | 1.6.0 |
128+
| `wednesday` | Day is a wednesday | 1.6.0 |
129+
| `thursday` | Day is a thursday | 1.6.0 |
130+
| `friday` | Day is a friday | 1.6.0 |
131+
| `saturday` | Day is a saturday | 1.6.0 |
123132

124133
### Event classes
125134

@@ -206,3 +215,12 @@ calendars:
206215
days: month
207216
startingDay: month
208217
```
218+
219+
### Show month with each day
220+
221+
```yaml
222+
type: custom:week-planner-card
223+
calendars:
224+
- calendar.my_calendar_1
225+
dayFormat: '''<span class="number">''d''</span> <span class="month">''MMMM''</span>'''
226+
```

0 commit comments

Comments
 (0)