Add Clock Card documentation (#38242)

This commit is contained in:
c0ffeeca7 2025-03-28 06:51:07 +01:00 committed by Franck Nijhof
parent 01501eb872
commit c16c4aa0f5
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
4 changed files with 78 additions and 0 deletions

View File

@ -0,0 +1,78 @@
---
type: card
title: "Clock card"
sidebar_label: Clock
description: "The Clock card shows the current time in a variety of formats and sizes."
related:
- docs: /docs/frontend/#user--or-browser-dependent-settings
title: Setup your time format and timezone
---
The Clock card shows the current time in a variety of formats and sizes.
<p class='img'>
<img src='/images/dashboards/clock_card_large.png' alt='Screenshot of the clock card'>
Screenshot of the clock card
</p>
{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
## Card settings
{% configuration_basic %}
Clock Size:
description: Adjusts the size of the text allowing a wider range of use with different types of dashboards. Defaults to small.
Display Seconds:
description: Shows seconds alongside the clock, providing the time format is in a 12-hour format.
Time Format:
description: Allows the time format to be changed on a per-card level. Defaults to the user profile setting.
{% endconfiguration_basic %}
### Examples
Basic example:
```yaml
type: clock
```
Clock card with no configuration
<p class='img'>
<img src='/images/dashboards/clock_card_default.png' alt='Screenshot of the basic clock card'>
Screenshot of the basic clock card
</p>
```yaml
type: clock
clock_size: large
time_format: "12"
show_seconds: true
grid_options:
columns: 12
rows: 2
```
Example of a larger clock card for tablet dashboards:
<p class='img'>
<img src='/images/dashboards/clock_card_large.png' alt='Screenshot of a large sized, 12 hour clock card showing am/pm and seconds'>
Screenshot of a large sized, 12 hour clock card showing am/pm and seconds
</p>
A medium-sized clock card better suited for desktop dashboards:
```yaml
type: clock
clock_size: medium
time_format: "12"
show_seconds: false
```
<p class='img'>
<img src='/images/dashboards/clock_card_medium.png' alt='Screenshot of a medium sized, 12 hour clock showing am/pm'>
Screenshot of a medium sized, 12 hour clock showing am/pm
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB