-
Notifications
You must be signed in to change notification settings - Fork 441
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1583 from UI-Lovelace-Minimalist/automated_custom…
…_card_docs [Action] Update custom_cards docs
- Loading branch information
Showing
2 changed files
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
title: Subtitle Custom-card | ||
hide: | ||
- toc | ||
--- | ||
|
||
<!-- markdownlint-disable MD046 --> | ||
|
||
# Custom-card "Subtitle" | ||
|
||
This is a `custom-card` to display a subtitle header. | ||
|
||
![Screenshot](../../assets/img/custom_card_wilbiev_subtitle.png) | ||
|
||
## Credits | ||
|
||
Author: wilbiev - 2023 | ||
Version: 1.0.0 | ||
|
||
## Changelog | ||
|
||
<details> | ||
<summary>1.0.0</summary> | ||
Initial release. | ||
</details> | ||
|
||
## Requirements | ||
|
||
This card needs the following to function correctly: | ||
|
||
['Text Divider Row'](https://github.com/iantrich/text-divider-row) | ||
|
||
## Variables | ||
|
||
<table> | ||
<tr> | ||
<th>Variable</th> | ||
<th>Example</th> | ||
<th>Required</th> | ||
<th>Default</th> | ||
<th>Explanation</th> | ||
</tr> | ||
<tr> | ||
<td>ulm_custom_card_wilbiev_subtitle_name</td> | ||
<td>"Subtitle"</td> | ||
<td>yes</td> | ||
<td></td> | ||
<td>The name to display</td> | ||
</tr> | ||
</table> | ||
|
||
## Usage | ||
|
||
```yaml | ||
- type: "custom:button-card" | ||
template: "custom_card_wilbiev_subtitle" | ||
variables: | ||
ulm_custom_card_wilbiev_title_name: "Lights" | ||
``` | ||
??? note "Template Code" | ||
```yaml title="custom_card_bar_card.yaml" | ||
--8<-- "custom_cards/custom_card_wilbiev_title/custom_card_wilbiev_subtitle.yaml" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
title: Title Custom-card | ||
hide: | ||
- toc | ||
--- | ||
|
||
<!-- markdownlint-disable MD046 --> | ||
|
||
# Custom-card "Title" | ||
|
||
This is a `custom-card` to display a title header. | ||
|
||
![Screenshot](../../assets/img/custom_card_wilbiev_title.png) | ||
|
||
## Credits | ||
|
||
Author: wilbiev - 2023 | ||
Version: 1.0.0 | ||
|
||
## Changelog | ||
|
||
<details> | ||
<summary>1.0.0</summary> | ||
Initial release. | ||
</details> | ||
|
||
## Requirements | ||
|
||
This card needs the following to function correctly: | ||
|
||
['Text Divider Row'](https://github.com/iantrich/text-divider-row) | ||
|
||
## Variables | ||
|
||
<table> | ||
<tr> | ||
<th>Variable</th> | ||
<th>Example</th> | ||
<th>Required</th> | ||
<th>Default</th> | ||
<th>Explanation</th> | ||
</tr> | ||
<tr> | ||
<td>ulm_custom_card_wilbiev_title_name</td> | ||
<td>"Title"</td> | ||
<td>yes</td> | ||
<td></td> | ||
<td>The name to display</td> | ||
</tr> | ||
<tr> | ||
<td>ulm_custom_card_wilbiev_title_nav</td> | ||
<td>"/adaptive-dash/home"</td> | ||
<td>no</td> | ||
<td>"<none>"</td> | ||
<td>"Navigate to another view. Shows the 'Back'-button when having a value"</td> | ||
</tr> | ||
</table> | ||
|
||
## Usage | ||
|
||
```yaml | ||
- type: "custom:button-card" | ||
template: "custom_card_wilbiev_title" | ||
variables: | ||
ulm_custom_card_wilbiev_title_name: "Living room" | ||
ulm_custom_card_wilbiev_title_nav: "/adaptive-dash/home" # OPTIONAL | ||
``` | ||
??? note "Template Code" | ||
```yaml title="custom_card_bar_card.yaml" | ||
--8<-- "custom_cards/custom_card_wilbiev_title/custom_card_wilbiev_title.yaml" | ||
``` |