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

Weather

A simple, live-updating local weather component, showing temperature, conditions and more info.

Options

Field	Type	Required	Description
apiKey	string	Required	Your OpenWeatherMap API key. You can get one for free at openweathermap.org
city	string	Required	A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format
units	string	Optional	The units to use for displaying data, can be either metric or imperial. Defaults to metric
hideDetails	boolean	Optional	If set to true, the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to false

Example

- name: Local Weather
  icon: fas fa-clouds
  type: weather
  options:
    apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    city: London
    units: metric
    hideDetails: false

Weather Forecast

Displays the weather (temperature and conditions) for the next few days for a given location. Note that this requires either the free OpenWeatherMap Student Plan, or the Premium Plan.

Options

Field	Type	Required	Description
apiKey	string	Required	Your OpenWeatherMap API key. You can get one for free at openweathermap.org
city	string	Required	A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format
numDays	number	Optional	The number of days to display of forecast info to display. Defaults to 4, max 16 days
units	string	Optional	The units to use for displaying data, can be either metric or imperial. Defaults to metric
hideDetails	boolean	Optional	If set to true, the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to false

Example

- name: Weather Forecast
  icon: ':sunny:'
  type: weather-forecast
  options:
    city: California
    numDays: 6
    apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    units: imperial

TFL Status

Shows real-time tube status of the London Underground. All options are optional.

Options

Field	Type	Required	Description
showAll	boolean	Optional	By default, details for lines with a Good Service are not visible, but you can click More Details to see all. Setting this option to true will show all lines on initial page load
sortAlphabetically	boolean	Optional	By default lines are sorted by current status, set this option to true to instead sort them alphabetically
linesToShow	array	Optional	By default all lines are shown. If you're only interested in the status of a few lines, then pass in an array of lines to show, specified by name

Example

  - name: TFL Status
    icon: '🚋'
    type: tfl-status
    options:
      showAll: true
      sortAlphabetically: true
      linesToShow:
      - District
      - Jubilee
      - Central

---

Dynamic Widgets

---

Build your own Widget