Add documentation for crypto widget
This commit is contained in:
parent
e6272e35ee
commit
93af94ff59
3 changed files with 67 additions and 0 deletions
|
@ -13,6 +13,7 @@
|
|||
* Latest YouTube videos from specific channels
|
||||
* Calendar
|
||||
* Stocks
|
||||
* Cryptocurrencies
|
||||
* iframe
|
||||
* Twitch channels & top games
|
||||
* GitHub releases
|
||||
|
|
|
@ -1038,6 +1038,72 @@ The link to go to when clicking on the symbol.
|
|||
`chart-link`
|
||||
The link to go to when clicking on the chart.
|
||||
|
||||
### Crypto
|
||||
Display a list of cryptocurrencies, their current value, change for the day and a small single day chart. Data is taken from CoinGecko.
|
||||
|
||||
Example:
|
||||
```yaml
|
||||
- type: crypto
|
||||
cryptos:
|
||||
- name: Bitcoin
|
||||
symbol: BTC
|
||||
id: bitcoin
|
||||
- name: Ethereum
|
||||
symbol: ETH
|
||||
id: ethereum
|
||||
- name: Avalanche
|
||||
symbol: AVAX
|
||||
id: avalanche-2
|
||||
- name: Solana
|
||||
symbol: SOL
|
||||
id: solana
|
||||
- name: Dogecoin
|
||||
symbol: DOGE
|
||||
id: dogecoin
|
||||
```
|
||||
|
||||
Preview:
|
||||

|
||||
|
||||
#### Properties
|
||||
| Name | Type | Required | Default |
|
||||
| ---- | ---- | -------- | ------- |
|
||||
| cryptos | array | yes | |
|
||||
| style | string | no | |
|
||||
| sort-by | string | no | |
|
||||
| days | string | no | 1 |
|
||||
|
||||
#### Properties for each cryptocurrency
|
||||
| Name | Type | Required | Default |
|
||||
| ---- | ---- | -------- | ------- |
|
||||
| symbol | string | yes | |
|
||||
| name | string | yes | |
|
||||
| id | string | yes | |
|
||||
| currency | string | no | usd |
|
||||
| symbol-link | string | no | |
|
||||
| days | string | no | |
|
||||
|
||||
##### `cryptos`
|
||||
An array of cryptocurrencies for which to display information about.
|
||||
|
||||
##### `currency`
|
||||
The currency in which to display the value of the cryptocurrency. Possible values are `usd`, `eur`, `gbp`, `jpy`, `cny`, `krw`, `inr`, `rub`, `brl`, `cad`, `aud`, `chf`, `hkd`, `twd`, `sgd`, `thb`, `idr`, `myr`, `php`, `zar`, `sek`, `nok`, `dkk`, `pln`, `huf`, `czk`, `ils`, `try`, `clp`, `mxn`, `php`, `cop`, `ars`, `pen`, `vef`, `ngn`, `kes`, `egp`, `aed`, `sar`, `qar`, `omr`, `kwd`, `bhd`, `jod`, `ils`, `lbp`, `jmd`, `tt`, `ttd`, `bsd`, `gyd`, `htg`, `npr`, `lkr`, `mvr`, `mur`, `scr`, `xaf`, `xof`, `xpf`, `xdr`, `xag`, `xau`, `bits`, `sats`.
|
||||
|
||||
##### `symbol-link`
|
||||
The link to go to when clicking on the symbol. Defaults to the CoinGecko page for the cryptocurrency.
|
||||
|
||||
##### `days`
|
||||
Number of days to show in the chart.
|
||||
|
||||
##### `symbol`
|
||||
The symbol of the cryptocurrency.
|
||||
|
||||
##### `name`
|
||||
The name of the cryptocurrency.
|
||||
|
||||
##### `id`
|
||||
The ID of the cryptocurrency as seen on CoinGecko.
|
||||
|
||||
### Twitch Channels
|
||||
Display a list of channels from Twitch.
|
||||
|
||||
|
|
BIN
docs/images/crypto-widget-preview.png
Normal file
BIN
docs/images/crypto-widget-preview.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 74 KiB |
Loading…
Add table
Reference in a new issue