Migrate entities to items

home-assistant · Sep 26, 2024 · 89b0d84 · 89b0d84
1 parent 7df4ebb
commit 89b0d84
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 13 deletions.
diff --git a/src/panels/lovelace/cards/hui-heading-card.ts b/src/panels/lovelace/cards/hui-heading-card.ts
@@ -21,6 +21,17 @@ import type {
 } from "../types";
 import type { HeadingCardConfig } from "./types";
 
+export const migrateHeadingCardConfig = (
+  config: HeadingCardConfig
+): HeadingCardConfig => {
+  const newConfig = { ...config };
+  if (newConfig.entities) {
+    newConfig.items = [...(newConfig.items || []), ...newConfig.entities];
+    delete newConfig.entities;
+  }
+  return newConfig;
+};
+
 @customElement("hui-heading-card")
 export class HuiHeadingCard extends LitElement implements LovelaceCard {
   public static async getConfigElement(): Promise<LovelaceCardEditor> {
@@ -47,7 +58,7 @@ export class HuiHeadingCard extends LitElement implements LovelaceCard {
       tap_action: {
         action: "none",
       },
-      ...config,
+      ...migrateHeadingCardConfig(config),
     };
   }
 
@@ -66,8 +77,8 @@ export class HuiHeadingCard extends LitElement implements LovelaceCard {
     handleAction(this, this.hass!, this._config!, ev.detail.action!);
   }
 
-  private _items = memoizeOne((entities: HeadingCardConfig["entities"]) =>
-    processEditorEntities(entities || [])
+  private _items = memoizeOne((items: HeadingCardConfig["items"]) =>
+    processEditorEntities(items || [])
   );
 
   protected render() {
@@ -79,7 +90,7 @@ export class HuiHeadingCard extends LitElement implements LovelaceCard {
 
     const style = this._config.heading_style || "title";
 
-    const items = this._items(this._config.entities);
+    const items = this._items(this._config.items);
 
     return html`
       <ha-card>

diff --git a/src/panels/lovelace/cards/types.ts b/src/panels/lovelace/cards/types.ts
@@ -509,5 +509,7 @@ export interface HeadingCardConfig extends LovelaceCardConfig {
   heading?: string;
   icon?: string;
   tap_action?: ActionConfig;
+  items?: (LovelaceHeadingItemConfig | string)[];
+  /** @deprecated Use `triggers` instead */
   entities?: (LovelaceHeadingItemConfig | string)[];
 }
diff --git a/src/panels/lovelace/editor/config-elements/hui-heading-card-editor.ts b/src/panels/lovelace/editor/config-elements/hui-heading-card-editor.ts
@@ -35,6 +35,7 @@ import { baseLovelaceCardConfig } from "../structs/base-card-struct";
 import { EditSubElementEvent } from "../types";
 import { configElementStyle } from "./config-elements-style";
 import "./hui-heading-items-editor";
+import { migrateHeadingCardConfig } from "../../cards/hui-heading-card";
 
 const actions: UiAction[] = ["navigate", "url", "perform-action", "none"];
 
@@ -45,6 +46,8 @@ const cardConfigStruct = assign(
     heading: optional(string()),
     icon: optional(string()),
     tap_action: optional(actionConfigStruct),
+    items: optional(array(any())),
+    // deprecated
     entities: optional(array(any())),
   })
 );
@@ -60,7 +63,7 @@ export class HuiHeadingCardEditor
 
   public setConfig(config: HeadingCardConfig): void {
     assert(config, cardConfigStruct);
-    this._config = config;
+    this._config = migrateHeadingCardConfig(config);
   }
 
   private _schema = memoizeOne(
@@ -108,8 +111,8 @@ export class HuiHeadingCardEditor
   );
 
   private _items = memoizeOne(
-    (entities: HeadingCardConfig["entities"]): LovelaceHeadingItemConfig[] =>
-      processEditorEntities(entities || [])
+    (items: HeadingCardConfig["items"]): LovelaceHeadingItemConfig[] =>
+      processEditorEntities(items || [])
   );
 
   protected render() {
@@ -145,7 +148,7 @@ export class HuiHeadingCardEditor
         <div class="content">
           <hui-heading-items-editor
             .hass=${this.hass}
-            .items=${this._items(this._config!.entities)}
+            .items=${this._items(this._config!.items)}
             @heading-items-changed=${this._itemsChanged}
             @edit-heading-item=${this._editItem}
           >
@@ -163,7 +166,7 @@ export class HuiHeadingCardEditor
 
     const config = {
       ...this._config,
-      entities: ev.detail.items as LovelaceHeadingItemConfig[],
+      items: ev.detail.items as LovelaceHeadingItemConfig[],
     };
 
     fireEvent(this, "config-changed", { config });
@@ -183,7 +186,7 @@ export class HuiHeadingCardEditor
   private _editItem(ev: HASSDomEvent<{ index: number }>): void {
     ev.stopPropagation();
     const index = ev.detail.index;
-    const config = this._items(this._config!.entities)[index];
+    const config = this._items(this._config!.items)[index];
 
     fireEvent(this, "edit-sub-element", {
       config: config,
@@ -193,9 +196,9 @@ export class HuiHeadingCardEditor
   }
 
   private _updateEntity(index: number, entity: EntityHeadingItemConfig) {
-    const entities = this._config!.entities!.concat();
-    entities[index] = entity;
-    const config = { ...this._config!, entities };
+    const items = this._config!.items!.concat();
+    items[index] = entity;
+    const config = { ...this._config!, items };
     fireEvent(this, "config-changed", {
       config: config,
     });