Week Planner Card

Custom Home Assistant card displaying a responsive overview of multiple days with events from one or multiple calendars

Table of Content
-
Installation
-
HACS (Recommended)
-
Manual
-
Configuration
-
Main options
-
Calendars
-
Texts
-
Weather
-
Custom styling using cardmod
-
Examples
Installation
HACS (Recommended)
- Make sure HACS is installed and working.
- Add this repository (https://github.com/FamousWolf/week-planner-card) via HACS Custom repositories
- Download and install using HACS
Manual
- Download and copy
eweek-planner-card.js
from the latest release into your config/www
directory.
- Add the resource reference to Home Assistant configuration using one of these methods:
Configuration
Main Options
Name |
Type |
Default |
Supported options |
Description |
Version |
type |
string |
Required |
custom:week-planner-card |
Type of the card |
1.0.0 |
days |
number | string |
7 |
Any positive integer number | month |
The number of days to show |
1.0.0 |
startingDay |
string |
today |
today | tomorrow | yesterday | sunday | monday | tuesday | wednesday | thursday | friday | saturday | month |
Day to start with |
1.2.0 |
hideWeekend |
boolean |
false |
false | true |
Do not show Saturday and Sunday |
1.2.0 |
noCardBackground |
boolean |
false |
false | true |
Do not show default card background and border |
1.0.0 |
eventBackground |
string |
var(--card-background-color, inherit) |
Any CSS color |
Background color of the events |
1.0.0 |
compact |
boolean |
false |
false | true |
Use compact mode, decreasing several spacings and font sizes |
1.2.0 |
updateInterval |
number |
60 |
Any positive integer number |
Seconds between checks for new events |
1.0.0 |
calendars |
object list |
Required |
See Calendars |
Calendars shown in this card |
1.0.0 |
texts |
object list |
{} |
See Texts |
Texts used in the card |
1.0.0 |
weather |
object |
optional |
See Weather |
Configuration for optional weather forecast |
1.1.0 |
dateFormat |
string |
cccc d LLLL yyyy |
See Luxon format |
Format of the date in event details |
1.0.0 |
timeFormat |
string |
HH:mm |
See Luxon format |
Format of the time |
1.0.0 |
locale |
string |
en |
Any locale string supported by Luxon |
Locale used for day and month texts |
1.1.0 |
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 |
showLocation |
boolean |
false |
false | true |
Show event location in overview |
1.3.0 |
hidePastEvents |
boolean |
false |
false | true |
Do not show past events |
1.3.0 |
hideDaysWithoutEvents |
boolean |
false |
false | true |
Do not show days without events, except for today |
1.4.0 |
Calendars
Name |
Type |
Default |
Supported options |
Description |
Version |
entity |
string |
Required |
calendar.my_calendar |
Entity ID |
1.0.0 |
color |
string |
optional |
Any CSS color |
Color used for events from the calendar |
1.0.0 |
Texts
Name |
Type |
Default |
Supported options |
Description |
Version |
fullDay |
string |
Entire day |
Any text |
Text shown for full day events instead of time |
1.0.0 |
noEvents |
string |
No events |
Any text |
Text shown when there are no events for a day |
1.0.0 |
today |
string |
Today |
Any text |
Text shown for today instead of the week day. Set to empty to show week day |
1.0.0 |
tomorrow |
string |
Tomorrow |
Any text |
Text shown for tomorrow instead of the week day. Set to empty to show week day |
1.0.0 |
yesterday |
string |
Yesterday |
Any text |
Text shown for yesterday instead of the week day. Set to empty to show week day |
1.2.0 |
sunday |
string |
Name of Sunday based on locale |
Any text |
Text used to override Sundays |
1.1.0 |
monday |
string |
Name of Monday based on locale |
Any text |
Text used to override Mondays |
1.1.0 |
tuesday |
string |
Name of Tuesday based on locale |
Any text |
Text used to override Tuesdays |
1.1.0 |
wednesday |
string |
Name of Wednesday based on locale |
Any text |
Text used to override Wednesdays |
1.1.0 |
thursday |
string |
Name of Thursday based on locale |
Any text |
Text used to override Thursdays |
1.1.0 |
friday |
string |
Name of Friday based on locale |
Any text |
Text used to override Fridays |
1.1.0 |
saturday |
string |
Name of Saturday based on locale |
Any text |
Text used to override Saturdays |
1.1.0 |
Weather
Name |
Type |
Default |
Supported options |
Description |
Version |
entity |
string |
Required |
weather.my_weather_service |
Entity ID |
1.1.0 |
showCondition |
boolean |
true |
false | true |
Show condition icon |
1.1.0 |
showTemperature |
boolean |
false |
false | true |
Show temperature |
1.1.0 |
showLowTemperature |
boolean |
false |
false | true |
Show low temperature |
1.1.0 |
Custom styling using cardmod
Like with most cards, you can add custom styling to this card using card_mod. To make it easier to add custom styles to days and/or events, there are several classes that days and events can have.
Day classes
Class |
Description |
Version |
today |
The current day |
1.5.0 |
tomorrow |
The next day |
1.5.0 |
yesterday |
The previous day |
1.5.0 |
future |
Day in the future |
1.5.0 |
past |
Day in the past |
1.5.0 |
Event classes
Class |
Description |
Version |
fullday |
Event lasts the full day |
1.5.0 |
ongoing |
Currently ongoing |
1.5.0 |
future |
Event in the future |
1.5.0 |
past |
Event in the past |
1.5.0 |
Examples
Minimal
type: custom:week-planner-card
calendars:
- entity: calendar.my_calendar_1
Extended
type: custom:week-planner-card
calendars:
- entity: calendar.my_calendar_1
color: '#e6c229'
- entity: calendar.my_calendar_2
color: '#1a8fe3'
weather:
entity: weather.my_weather_service
showTemperature: true
showLowTemperature: true
days: 14
noCardBackground: true
eventBackground: rgba(0, 0, 0, .75)
locationLink: https://www.openstreetmap.org/search?query=
locale: nl
texts:
noEvents: Geen activiteiten
fullDay: Hele dag
today: Vandaag
tomorrow: Morgen
Starting on Sunday
type: custom:week-planner-card
calendars:
- entity: calendar.my_calendar_1
color: '#e6c229'
- entity: calendar.my_calendar_2
color: '#1a8fe3'
startingDay: sunday
texts:
today: ''
tomorrow: ''
yesterday: ''
Past events transparent with card_mod
type: custom:week-planner-card
calendars:
- entity: calendar.my_calendar_1
color: '#e6c229'
- entity: calendar.my_calendar_2
color: '#1a8fe3'
card_mod:
style: |
.event.past {
opacity: .3;
}
Show entire current month
type: custom:week-planner-card
calendars:
- entity: calendar.my_calendar_1
days: month
startingDay: month