Skip to content

feat: Add "persistentID" option #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ildar170975 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: Add "persistentID" option #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
325fcbf
added "persistentID" option
ildar170975 Feb 25, 2025
6d3be47
added "persistentID"
ildar170975 Feb 25, 2025
f352d5e
Update package.json
ildar170975 Feb 25, 2025
9575df5
prettier
ildar170975 Feb 25, 2025
26a055b
revert
ildar170975 Feb 25, 2025
05a7ad4
Merge branch 'main' into user-defined-id
ildar170975 Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ tabs:
minWidth?: boolean
isMinWidthIndicator?: boolean
stacked?: boolean
persistentID?: string
```

### Example
Expand Down Expand Up @@ -131,6 +132,7 @@ See the full list of exposed custom properties: [`<mwc-tab>`](https://github.com
| `minWidth` | `false` | Shrinks tab as narrow as possible without causing text to wrap. |
| `isMinWidthIndicator` | `false` | Shrinks indicator to be the size of the content. |
| `stacked` | `false` | Stacks icon on top of label text. |
| `persistentID` | `""` | Persistent part of `id` for `mwc-tab` element (tab level only) |

Global attributes:

Expand Down Expand Up @@ -199,6 +201,12 @@ tabs:

![Local Attributes](assets/local-attributes.png)


## Usage of `persistentID`

Every `mwc-tab` element gets an `id` as a combination of some static part & dynamic part to ensure a unique value of `id`.
A value of an optional `persistentID` option is used to customize the static part which can be useful in card-mod customizations to refer a particular tab.

## Appreciation

Thanks for the support and services provided ![Home Assistant](https://avatars.githubusercontent.com/u/13844975?s=24) [Home Assistant](https://www.home-assistant.io/), ![HACS](https://avatars.githubusercontent.com/u/56713226?s=24) [HACS](https://hacs.xyz/) and ![lit](https://avatars.githubusercontent.com/u/18489846?s=24) [lit](https://lit.dev/) 🥰 Aslo, thanks to the [swipe-card](https://github.com/bramkragten/swipe-card) for inspiration and all of the other open source cards/projects as references.
7 changes: 7 additions & 0 deletions src/tabbed-card.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ interface Tab {
minWidth?: boolean;
isMinWidthIndicator?: boolean;
stacked?: boolean;
persistentID?: string;
};
card: LovelaceCardConfig;
}
Expand Down Expand Up @@ -165,6 +166,12 @@ export class TabbedCard extends LitElement {
(tab) =>
html`
<mwc-tab
.id="mdc-tab-${tab?.attributes?.persistentID
? tab?.attributes.persistentID + "-"
: ""}
${Math.random()
.toString(36)
.substring(2, 9)}"
style=${ifDefined(styleMap(tab?.styles || {}))}
label="${tab?.attributes?.label || nothing}"
?hasImageIcon=${tab?.attributes?.icon}
Expand Down