Skip to content

Commit

Permalink
Merge pull request #1504 from totaldebug/beta
Browse files Browse the repository at this point in the history 
Release v10
  • Loading branch information
@marksie1988
marksie1988 authored Jun 24, 2024
2 parents 5faee8e + c2f4205 commit f1b9d9e
Show file tree
Hide file tree
Showing 36 changed files with 2,373 additions and 1,983 deletions.
12 changes: 9 additions & 3 deletions .devcontainer/devcontainer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
"customizations": {
"vscode": {
"settings": {
"[json]": {
"editor.tabSize": 4,
"editor.formatOnPaste": true,
"editor.formatOnSave": true,
"editor.formatOnType": true,
"files.trimTrailingWhitespace": true
},
"terminal.integrated.profiles.linux": {
"zsh": {
"path": "/bin/zsh"
Expand All @@ -20,12 +27,11 @@
"editor.formatOnType": true,
"files.trimTrailingWhitespace": true,
"editor.codeActionsOnSave": {
"source.fixAll": true
"source.fixAll": "always"
},
"eslint.validate": [
"typescript"
],
format
]
},
"extensions": [
"github.vscode-pull-request-github",
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ dist/*
!.devcontainer/post-install.sh
dist

.DS_Store
.vscode/*

# Logs
Expand Down
26 changes: 13 additions & 13 deletions docs/configuration/calendar.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
Calendar Mode Options
#####################

========================= ========== ======== ============================================================================================================
Name Type Since Description
========================= ========== ======== ============================================================================================================
enableModeChange boolean v0.7.0 ``false`` Set true to enable mode change (Calendar/Events) must have "name" set to toggle
firstDayOfWeek integer v0.7.0 ``1`` First day of week, default 1 for Monday
showLastCalendarWeek boolean v0.7.5 ``false`` If true it will always show 6 lines. If false, the 6th line won't be displayed if not needed.
calEventTime boolean v1.5.0 ``false`` If true the time will be shown on the event summary for the selected day
disableCalEventLink boolean v1.5.0 ``false`` If true the link will be disabled on the event summary for the selected day
disableCalLocationLink boolean v1.5.0 ``false`` If true the link will be disabled on the event location icon for the selected day
calShowDescription boolean v2.5.0 ``false`` If true this will display the description in calendar mode
disableCalLink boolean v3.0.0 ``false`` If true the link to google calendar will be removed
cardHeight string v4.3.0 ``100%`` Change to ``px`` or ``%`` to set the height of the card, this will add scroll if it is too small
========================= ========== ======== ============================================================================================================
========================= ========== ============================================================================================================
Name Type Description
========================= ========== ============================================================================================================
enableModeChange boolean ``false`` Set true to enable mode change (Calendar/Events) must have "name" set to toggle
firstDayOfWeek integer ``1`` First day of week, default 1 for Monday
showLastCalendarWeek boolean ``false`` If true it will always show 6 lines. If false, the 6th line won't be displayed if not needed.
calEventTime boolean ``false`` If true the time will be shown on the event summary for the selected day
disableCalEventLink boolean ``false`` If true the link will be disabled on the event summary for the selected day
disableCalLocationLink boolean ``false`` If true the link will be disabled on the event location icon for the selected day
calShowDescription boolean ``false`` If true this will display the description in calendar mode
disableCalLink boolean ``false`` If true the link to google calendar will be removed
cardHeight string ``100%`` Change to ``px`` or ``%`` to set the height of the card, this will add scroll if it is too small
========================= ========== ============================================================================================================
32 changes: 16 additions & 16 deletions docs/configuration/entity.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
Entity Options
##############

==================== ========= ======== =============================================================================================================
Name Type Since Description
==================== ========= ======== =============================================================================================================
icon string v2.0.0 ``null`` Add an icon to a calendar. If not set, will use the entity icon set in HA. see note below
startTimeFilter string v2.0.0 Only shows events between specific times _NOTE_ must be set with ``endTimeFilter`` format: ``'10:00'``
endTimeFilter string v2.0.0 Only shows events between specific times _NOTE_ must be set with ``startTimeFilter`` format: ``'17:00'``
maxDaysToShow integer v5.2.0 ``7`` Maximum number of days to show. Overrides main configuration maxDaysToShow for this calendar
blocklist string v7.0.0 ``null`` Simple case insensitive regex to ignore events that match title
blocklistLocation string v7.0.0 ``null`` Simple case insensitive regex to ignore events that match location
allowlist string v7.0.0 ``null`` Simple case insensitive regex to ignore events that match title
allowlistLocation string v7.0.0 ``null`` Simple case insensitive regex to only add events that match location
showMultiDay boolean v7.0.0 ``false`` Split multi-day events across all days
name string v7.0.0 ``null`` Add a calendar name to be shown with event
eventTitle string v7.3.0 Where no event title exists, add this string instead, Will only add to this entity, can also be globally set
color string ``null`` Default color for this calendar's event titles
==================== ========= ======== =============================================================================================================
==================== ========= =============================================================================================================
Name Type Description
==================== ========= =============================================================================================================
icon string ``null`` Add an icon to a calendar. If not set, will use the entity icon set in HA. see note below
startTimeFilter string Only shows events between specific times _NOTE_ must be set with ``endTimeFilter`` format: ``'10:00'``
endTimeFilter string Only shows events between specific times _NOTE_ must be set with ``startTimeFilter`` format: ``'17:00'``
maxDaysToShow integer ``7`` Maximum number of days to show. Overrides main configuration maxDaysToShow for this calendar
blocklist string ``null`` Simple case insensitive regex to ignore events that match title
blocklistLocation string ``null`` Simple case insensitive regex to ignore events that match location
allowlist string ``null`` Simple case insensitive regex to ignore events that match title
allowlistLocation string ``null`` Simple case insensitive regex to only add events that match location
showMultiDay boolean ``false`` Split multi-day events across all days
name string ``null`` Add a calendar name to be shown with event
eventTitle string Where no event title exists, add this string instead, Will only add to this entity, can also be globally set
color string ``null`` Default color for this calendar's event titles
==================== ========= =============================================================================================================

.. note::
It is not advised to use ``allowlist`` & ``blocklist`` under the same entity.
Expand Down
40 changes: 20 additions & 20 deletions docs/configuration/event.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@
Event Mode Options
##################

======================= ========== ======== ===========================================================================================================
Name Type Since Description
======================= ========== ======== ===========================================================================================================
showCurrentEventLine boolean v0.3.0 ``false`` Show line before next event. Don't enable when showProgressBar is true - will look bad
showProgressBar boolean v0.5.5 ``true`` Show event progress with moving icon. Don't enable when showCurrentEventLine - will look bad
showFullDayProgress boolean v1.7.0 ``false`` Enables the progress bar for full day events
showRelativeTime boolean v2.1.0 ``true`` Show relative time until the start of an event
showEventIcon boolean v2.2.3 ``false`` Show the entity icon before the event title
europeanDate boolean v2.2.3 ``false`` Show date for event days in european format
softLimit integer v2.7.0 Adds flexibility when ``maxEventCount`` is set, so if there is only e.g. 1 extra event it would be shown
showHiddenText boolean v3.3.0 ``true`` Show x hidden events when limited number of events selected
hiddenEventText string v3.3.0 ``localize('common.hiddenEventText')`` allows a user to change the text displayed for hidden events
showCalendarName boolean v7.0.0 ``false`` Show the calendar name in Event Mode
showWeekNumber boolean v7.0.0 ``false`` Show the year week number at the beginning of each week
showEventDate boolean v7.1.0 ``true`` Show the event date
showDatePerEvent boolean v7.2.0 ``false`` Show the date next to each event entry
showTimeRemaining boolean v7.3.0 ``false`` Show the amount of time remaining for an event
hoursOnSameLine boolean v7.3.0 ``false`` if set true will move hours to show on the same line as the summary.
showAllDayHours boolean v7.5.0 ``true`` Show "All Day" text under full day events
======================= ========== ======== ===========================================================================================================
======================= ========== ===========================================================================================================
Name Type Description
======================= ========== ===========================================================================================================
showCurrentEventLine boolean ``false`` Show line before next event. Don't enable when showProgressBar is true - will look bad
showProgressBar boolean ``true`` Show event progress with moving icon. Don't enable when showCurrentEventLine - will look bad
showFullDayProgress boolean ``false`` Enables the progress bar for full day events
showRelativeTime boolean ``true`` Show relative time until the start of an event
showEventIcon boolean ``false`` Show the entity icon before the event title
softLimit integer Adds flexibility when ``maxEventCount`` is set, so if there is only e.g. 1 extra event it would be shown
showHiddenText boolean ``true`` Show x hidden events when limited number of events selected
hiddenEventText string ``localize('common.hiddenEventText')`` allows a user to change the text displayed for hidden events
showCalendarName boolean ``false`` Show the calendar name in Event Mode
showWeekNumber boolean ``false`` Show the year week number at the beginning of each week
showEventDate boolean ``true`` Show the event date
showDatePerEvent boolean ``false`` Show the date next to each event entry
showTimeRemaining boolean ``false`` Show the amount of time remaining for an event
hoursOnSameLine boolean ``false`` if set true will move hours to show on the same line as the summary.
showAllDayHours boolean ``true`` Show "All Day" text under full day events
eventDateFormat string ``ddd D MMM`` Set the date format for events
======================= ========== ===========================================================================================================
20 changes: 11 additions & 9 deletions docs/configuration/language.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Language Options
.. note:
Week / month names are translated automatically
========================== ========= ======== ===============================================================================================================================================================================================================
Name Type Since Description
========================== ========= ======== ===============================================================================================================================================================================================================
untilText string v0.3.0 ``Until`` Custom text for ``Until`` text
fullDayEventText string v0.3.0 ``All day`` Custom text for ``All day`` text
noEventsForNextDaysText string v0.8.6 ``No events in the next days`` Custom text for ``No events in the next days`` text
noEventText string v4.1.0 ``No events`` Custom text for ``No events`` text, only if ``showNoEventsForToday`` or ``showNoEventDays`` is true
dateFormat string v0.7.2 ``LL`` Custom date format - see `list of localized formats <https://day.js.org/docs/en/display/format#localized-formats>`_
========================== ========= ======== ===============================================================================================================================================================================================================
========================== ========= ===============================================================================================================================================================================================================
Name Type Description
========================== ========= ===============================================================================================================================================================================================================
untilText string ``Until`` Custom text for ``Until`` text
fullDayEventText string ``All day`` Custom text for ``All day`` text
noEventsForNextDaysText string ``No events in the next days`` Custom text for ``No events in the next days`` text
noEventText string ``No events`` Custom text for ``No events`` text, only if ``showNoEventsForToday`` or ``showNoEventDays`` is true
dateFormat string ``LL`` Custom date format - see `list of localized formats <https://day.js.org/docs/en/display/format#localized-formats>`_
========================== ========= ===============================================================================================================================================================================================================


**************
Expand Down Expand Up @@ -44,6 +44,7 @@ The Configuration editor supports the following locales:
ru Russian
sl Slovenian
sv Swedish
uk Ukranian
========= ===========


Expand Down Expand Up @@ -92,6 +93,7 @@ The card date information supports the following locales:
sl Slovenian
sv Swedish
sk Slovak
uk Ukranian
========= ==============================

.. note:
Expand Down
Loading

0 comments on commit f1b9d9e

Please sign in to comment.