mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Add documentation for Spotify module
This commit is contained in:
54
_site/content/modules/spotify.md
Normal file
54
_site/content/modules/spotify.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: "Spotify"
|
||||
date: 2018-10-02T17:13:11-07:00
|
||||
draft: false
|
||||
weight: 205
|
||||
---
|
||||
|
||||
Control the Spotify client.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/spotify/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
<span class="caption">Action:</span> Open/close the widget's help window.
|
||||
|
||||
<span class="caption">Key:</span> `space` <br />
|
||||
<span class="caption">Action:</span>
|
||||
|
||||
<span class="caption">Key:</span> `h` <br />
|
||||
<span class="caption">Action:</span>
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span>
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
spotify:
|
||||
enabled: true
|
||||
position:
|
||||
top: 1
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 0
|
||||
```
|
||||
|
||||
## Attributes
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
Reference in New Issue
Block a user