Skip to content

add info for clock css and deprecated property, #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rejas merged 1 commit into from
Mar 31, 2025
Merged

add info for clock css and deprecated property, #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/calendar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following properties can be configured:
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `maximumEntries` | The maximum number of events shown. / **Possible values:** `0` - `100` <br> **Default value:** `10` |
| `maximumNumberOfDays` | The maximum number of days in the future. <br><br> **Default value:** `365` |
| `pastDaysCount` | The number of days of which events in the past should be displayed. <br><br> **Default value:** `0` |
| `pastDaysCount` | The number of days of which events in the past should be displayed. <br><br> **Default value:** `0`<br> `NOTE: this value is advisory to any module processing the events broadcast.`<br>`the default calendar module never displays events from the past` |
| `displaySymbol` | Display a symbol in front of an entry. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true` |
| `defaultSymbol` | The default symbol. <br><br> **Possible values:** See [Font Awesome](https://fontawesome.com/v6/search?o=r&m=free) website. <br> **Default value:** `calendar` |
| `showLocation` | Whether to show event locations. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false` |
Expand Down
4 changes: 3 additions & 1 deletion modules/clock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following properties can be configured:
| `displayType` | Display a digital clock, analog clock, or both together. <br><br> **Possible values:** `digital`, `analog`, or `both` <br> **Default value:** `digital` |
| `analogSize` | **Specific to the analog clock.** Defines how large the analog display is. <br><br> **Possible values:** `A positive number of pixels` <br> **Default value:** `200px` |
| `analogFace` | **Specific to the analog clock.** Specifies which clock face to use. <br><br> **Possible values:** `simple` for a simple border, `none` for no face or border, or `face-###` (where ### is currently a value between 001 and 012, inclusive) <br> **Default value:** `simple` |
| `secondsColor` | **Specific to the analog clock.** Specifies what color to make the 'seconds' hand. <br><br> **Possible values:** `any HTML RGB Color` <br> **Default value:** `#888888` |
| `secondsColor` | **Specific to the analog clock.** Specifies what color to make the 'seconds' hand. <br><br> **Possible values:** `any HTML RGB Color` <br> **Default value:** `#888888`<br> // starting in version 2.31.0 this property is DEPRECATED, and WILL be removed in some future version. Use CSS instead. Class "clock-second-digital" for digital clock, "clock-second" for analog clock. |
| `analogPlacement` | **Specific to the analog clock. _(requires displayType set to `'both'`)_** Specifies where the analog clock is in relation to the digital clock <br><br> **Possible values:** `top`, `right`, `bottom`, or `left` <br> **Default value:** `bottom` |
| `analogShowDate` | **Obsolete**, can be replaced with analogPlacement and showTime. <br><br>**Specific to the analog clock.** If the clock is used as a separate module and set to analog only, this configures whether a date is also displayed with the clock. <br><br> **Possible values:** `false`, `top`, or `bottom` <br> **Default value:** `top` |
| `sendNotifications` | Enable notifications for elapsed time. Used to be always done send prio to v2.23 <br><br> **Possible values:** `true`, or `false` <br> **Default value:** `false` |
Expand All @@ -64,3 +64,5 @@ Current notifications are:
| -------------- | ---------------------------------------------------- |
| `CLOCK_SECOND` | A second has elapsed. <br> _Parameter_: second value |
| `CLOCK_MINUTE` | A minute has elapsed <br> _Parameter_: minute value |

## styles for clock hands (analog) and text (digital) can be found in clock_style.css, use css/custom.css to override