ljmerza / calendar-card

Home Assistant Lovelace UI Custom Google Calendar Card

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

as of hass 0.115 a built in calendar card is included so this card is archived and will no longer be developed. if any features are missing in the new card, open pull requests against lovelace to get them added.

Calendar Card for Home Assistant

Show Google calendar events

GitHub Release License

Project Maintenance GitHub Activity hacs_badge

Features


  • Show the next 5 events on your Google Calendar (default set by home assistant)
  • Set custom time and date format for each event
  • Click on event to open in your Google calendar app
  • Integrate multiple calendars
  • Update notifications via custom_updater
  • Click on event location to open maps app
  • Language support
  • Progress bar for ongoing events
  • Split multiday events
  • Notifications of new events
  • Customize date time formats
  • Enable kiosk mode (no click events)

Installation


You should have setup Google calendar integration or Caldav integration in HomeAssistant. Installation through HACS

Options


Name Type Requirement Description
type string Required custom:calendar-card
entities object Required List of calendars to display
dateTopFormat string Optional DD Format for top line of event date
dateBottomFormat string Optional ddd Format to bottom line of event date
disableLinks boolean Optional false Disables all links (to open calendar and location)
useSourceUrl boolean Optional false Open events via the source url instead of html link
endText string Optional End Set custom text for event end time
eventsLimit integer Optional 99 Maximum number of events to show (shows rest of day after cut off)
fullDayEventText string Optional All day Set custom text for a full day event
hardLimit boolean Optional false Overrides eventsLimit default of showing rest of day's events even after cutoff
hideDeclined boolean Optional false Hides events that you declined
hideHeader boolean Optional false Hide the header regardless of value
hidePastEvents boolean Optional false Hide events that have passed
hideTime boolean Optional false Hides event time section entirely
highlightToday boolean Optional false Hightlight's today's events
ignoreEventsByLocationExpression string Optional Simple case insensitive regex to ignore events that match location
ignoreEventsExpression string Optional Simple case insensitive regex to ignore events that match title
maxHeight boolean Optional false Sets max height for card to 500px and overflows the rest
notifyEntity Entity Optional Send a notification on new events
notifyDateTimeFormat string Optional MM/DD/YYYY HH:mma Format for event date/time in notify message (see here for options)
numberOfDays number Optional 7 Number of days to display from calendars
removeFromEventTitle string Optional Removes substring from all event titles (case insensitive)
progressBar boolean Optional false Adds progress bar to ongoing events
showEventOrigin boolean Optional false Shows what calendar each event is from
showLocation boolean Optional false Shows location address
showLocationIcon boolean Optional true Shows map icon when event has a location
showMultiDay boolean Optional false Split multiday events into per day
startText string Optional Start Set custom text for event start time
title string Optional Calendar Header shown at top of card
timeFormat string Optional HH:mm Format to show event time (see here for options)

Configurations


type: custom:calendar-card
title: "My Calendar"
progressBar: true
entities:
  - calendar.ljmerzagmailcom

You want more than 5 Google events?

Open the google_calendars.yaml file and and max_results: 20 for each calendar items you want more events for. See documentation at Home Assistant


Enjoy my card? Help me out for a couple of 🍻 or a ☕!

coffee

About

Home Assistant Lovelace UI Custom Google Calendar Card

License:MIT License


Languages

Language:JavaScript 100.0%