Fredrik Andersson 6c6268a08e
Update documentation for how cards can be configured in the UI (#21556)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <git@frenck.dev>
fixes undefined
2023-01-16 17:54:11 +01:00

2.2 KiB

type, title, sidebar_label, description
type title sidebar_label description
card Calendar Card Calendar The calendar card displays your calendar entities in a month, day and list view

The Calendar card displays your calendar entities in a month, day and list view (7 days).

Screenshot of the 
  calendar card Screenshot of the Calendar card.

To add the Calendar card to your user interface, click the menu (three dots at the top right of the screen) and then Edit Dashboard. Click the Add Card button in the bottom right corner and select from the card picker.

All options for this card can be configured via the user interface.

Card Settings

{% configuration_basic %} Title: description: The title displayed at the top of the card. Initial View: description: "The view that will show first when the card is loaded onto the page. Options are Month View, Day View, or List (7 days)." Entities: description: The calendar entities that will be displayed in the card. Theme: description: Name of any loaded theme to be used for this card. For more information about themes, see the frontend documentation. {% endconfiguration_basic %}

YAML Configuration

The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.

{% configuration %} type: required: true description: "calendar" type: string title: required: false description: The title of the card. type: string initial_view: required: false description: "The view that will show first when the card is loaded onto the page. Options are dayGridMonth, dayGridDay, and listWeek. Note that listWeek does show the next 7 days, not a calendar week." type: string entities: required: true description: A list of calendar entities that will be displayed in the card. type: list theme: required: false description: Override the used theme for this card with any loaded theme. For more information about themes, see the frontend documentation. type: string {% endconfiguration %}

Examples

type: calendar
entities:
  - calendar.calendar_1
  - calendar.calendar_2