dashy/docs/widgets.md

Widgets

Dashy has support for displaying dynamic content in the form of widgets. There are several built-in widgets availible out-of-the-box (with more on the way!) as well as support for custom widgets to display stats from almost any service with an accessible API.

Contents

• Built-In Widgets
• Dynamic Widgets
• Build your own Widget

Built-In Widgets

Clock

A simple, live-updating time and date widget with time-zone support. All options are optional.

Options

Field	Type	Required	Description
timeZone	string	Optional	The time zone to display date and time in. Specified as Region/City, for example: Australia/Melbourne. See the Time Zone DB for a full list of supported TZs. Defaults to the browser / device's local time
format	string	Optional	A country code for displaying the date and time in local format. Specified as [ISO-3166]-[ISO-639], for example: en-AU. See here for a full list of locales. Defaults to the browser / device's region
hideDate	boolean	Optional	If set to true, the date and city will not be shown. Defaults to false

Example

- name: London Time
  icon: fas fa-clock
  type: clock
  options:
    timeZone: Europe/London
    format: en-GB
    hideDate: false

---

Dynamic Widgets

---

Build your own Widget