Skip to content

Commit 395343f

Browse files
FamousWolfFamousWolf
authored
Merge pull request #171 from FamousWolf/dev
[MERGE] Changes for version 1.8.0
2 parents 457a51b + 40d7e1e commit 395343f

File tree

6 files changed

+277
-311
lines changed

6 files changed

+277
-311
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.idea/
12
.parcel-cache/
23
node_modules/
34
dist/week-planner-card.js

‎README.md

Lines changed: 37 additions & 30 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.7.1
42+
- url: /local/week-planner-card.js?version=1.8.0
4343
type: module
4444
```
4545
- **Using the graphical editor**
@@ -53,38 +53,42 @@ 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-
| `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-
| `startingDayOffset` | number | 0 | Any integer number | Add or subtract days from starting day | 1.7.0 |
63-
| `hideWeekend` | boolean | false | `false` \| `true` | Do not show Saturday and Sunday | 1.2.0 |
64-
| `noCardBackground` | boolean | false | `false` \| `true` | Do not show default card background and border | 1.0.0 |
65-
| `eventBackground` | string | `var(--card-background-color, inherit)` | Any CSS color | Background color of the events | 1.0.0 |
66-
| `compact` | boolean | false | `false` \| `true` | Use compact mode, decreasing several spacings and font sizes | 1.2.0 |
67-
| `updateInterval` | number | 60 | Any positive integer number | Seconds between checks for new events | 1.0.0 |
68-
| `calendars` | object list | **Required** | See [Calendars](#calendars) | Calendars shown in this card | 1.0.0 |
69-
| `texts` | object list | {} | See [Texts](#texts) | Texts used in the card | 1.0.0 |
70-
| `weather` | object | optional | See [Weather](#weather) | Configuration for optional weather forecast | 1.1.0 |
71-
| `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 |
72-
| `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 |
73-
| `timeFormat` | string | `HH:mm` | See [Luxon format](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) | Format of the time | 1.0.0 |
74-
| `locale` | string | `en` | Any locale string supported by Luxon | Locale used for day and month texts | 1.1.0 |
75-
| `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 |
76-
| `showLocation` | boolean | false | `false` \| `true` | Show event location in overview | 1.3.0 |
77-
| `hidePastEvents` | boolean | false | `false` \| `true` | Do not show past events | 1.3.0 |
78-
| `hideDaysWithoutEvents` | boolean | false | `false` \| `true` | Do not show days without events, except for today | 1.4.0 |
79-
| `filter` | string | optional | Any regular expression | Remove events that match the regular expression | 1.7.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+
| `startingDayOffset` | number | 0 | Any integer number | Add or subtract days from starting day | 1.7.0 |
63+
| `hideWeekend` | boolean | false | `false` \| `true` | Do not show Saturday and Sunday | 1.2.0 |
64+
| `noCardBackground` | boolean | false | `false` \| `true` | Do not show default card background and border | 1.0.0 |
65+
| `eventBackground` | string | `var(--card-background-color, inherit)` | Any CSS color | Background color of the events | 1.0.0 |
66+
| `compact` | boolean | false | `false` \| `true` | Use compact mode, decreasing several spacings and font sizes | 1.2.0 |
67+
| `updateInterval` | number | 60 | Any positive integer number | Seconds between checks for new events | 1.0.0 |
68+
| `calendars` | object list | **Required** | See [Calendars](#calendars) | Calendars shown in this card | 1.0.0 |
69+
| `texts` | object list | {} | See [Texts](#texts) | Texts used in the card | 1.0.0 |
70+
| `actions` | object list | {} | See [Actions](#actions) | Actions for the card | 1.8.0 |
71+
| `weather` | object | optional | See [Weather](#weather) | Configuration for optional weather forecast | 1.1.0 |
72+
| `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 |
73+
| `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 |
74+
| `timeFormat` | string | `HH:mm` | See [Luxon format](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) | Format of the time | 1.0.0 |
75+
| `locale` | string | `en` | Any locale string supported by Luxon | Locale used for day and month texts | 1.1.0 |
76+
| `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 |
77+
| `showLocation` | boolean | false | `false` \| `true` | Show event location in overview | 1.3.0 |
78+
| `hidePastEvents` | boolean | false | `false` \| `true` | Do not show past events | 1.3.0 |
79+
| `hideDaysWithoutEvents` | boolean | false | `false` \| `true` | Do not show days without events, except for today | 1.4.0 |
80+
| `hideTodayWithoutEvents` | boolean | false | `false` \| `true` | Also do not show today without events if `hideDaysWithoutEvents` is set | 1.8.0 |
81+
| `filter` | string | optional | Any regular expression | Remove events that match the regular expression | 1.7.0 |
8082

8183
### Calendars
8284

83-
| Name | Type | Default | Supported options | Description | Version |
84-
|----------|--------|--------------|------------------------|-----------------------------------------|---------|
85-
| `entity` | string | **Required** | `calendar.my_calendar` | Entity ID | 1.0.0 |
86-
| `name` | string | optional | Any text | Name of the calendar | 1.7.0 |
87-
| `color` | string | optional | Any CSS color | Color used for events from the calendar | 1.0.0 |
85+
| Name | Type | Default | Supported options | Description | Version |
86+
|----------------|---------|--------------|------------------------|-------------------------------------------------|---------|
87+
| `entity` | string | **Required** | `calendar.my_calendar` | Entity ID | 1.0.0 |
88+
| `name` | string | optional | Any text | Name of the calendar | 1.7.0 |
89+
| `color` | string | optional | Any CSS color | Color used for events from the calendar | 1.0.0 |
90+
| `filter` | string | optional | Any regular expression | Remove events that match the regular expression | 1.8.0 |
91+
| `hideInLegend` | boolean | false | `false` \| `true` | Do not show the calendar in the legend | 1.8.0 |
8892

8993
### Texts
9094

@@ -103,6 +107,9 @@ Custom Home Assistant card displaying a responsive overview of multiple days wit
103107
| `friday` | string | Name of Friday based on locale | Any text | Text used to override Fridays | 1.1.0 |
104108
| `saturday` | string | Name of Saturday based on locale | Any text | Text used to override Saturdays | 1.1.0 |
105109

110+
### Actions
111+
See [Actions documentation](https://www.home-assistant.io/dashboards/actions/). Currently only the tab action is supported.
112+
106113
### Weather
107114

108115
| Name | Type | Default | Supported options | Description | Version |

0 commit comments

Comments
 (0)