Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wilbiev authored Dec 28, 2024
1 parent 89441e4 commit 56d6b03
Show file tree
Hide file tree
Showing 2 changed files with 138 additions and 0 deletions.
65 changes: 65 additions & 0 deletions docs/usage/custom_cards/custom_card_wilbiev_subtitle.md
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"
```
73 changes: 73 additions & 0 deletions docs/usage/custom_cards/custom_card_wilbiev_title.md
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"
```

0 comments on commit 56d6b03

Please sign in to comment.