Skip to content
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

Jump to bottom

Add listeners to template helper preview #17833

Merged
merged 1 commit into from
Sep 6, 2023
Merged

Add listeners to template helper preview #17833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/data/ws-templates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export interface RenderTemplateResult {
listeners: TemplateListeners;
}

interface TemplateListeners {
export interface TemplateListeners {
all: boolean;
domains: string[];
entities: string[];
Expand All @@ -18,6 +18,7 @@ export type TemplatePreview = TemplatePreviewState | TemplatePreviewError;
interface TemplatePreviewState {
state: string;
attributes: Record<string, any>;
listeners: TemplateListeners;
}

interface TemplatePreviewError {
Expand Down
75 changes: 70 additions & 5 deletions src/dialogs/config-flow/previews/flow-preview-template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { HassEntity, UnsubscribeFunc } from "home-assistant-js-websocket";
import { LitElement, html } from "lit";
import { LitElement, html, nothing } from "lit";
import { customElement, property, state } from "lit/decorators";
import { debounce } from "../../../common/util/debounce";
import { FlowType } from "../../../data/data_entry_flow";
import {
TemplateListeners,
TemplatePreview,
subscribePreviewTemplate,
} from "../../../data/ws-templates";
Expand All @@ -27,6 +28,8 @@ class FlowPreviewTemplate extends LitElement {

@state() private _preview?: HassEntity;

@state() private _listeners?: TemplateListeners;

@state() private _error?: string;

private _unsub?: Promise<UnsubscribeFunc>;
Expand All @@ -50,9 +53,69 @@ class FlowPreviewTemplate extends LitElement {
return html`<ha-alert alert-type="error">${this._error}</ha-alert>`;
}
return html`<entity-preview-row
.hass=${this.hass}
.stateObj=${this._preview}
></entity-preview-row>`;
.hass=${this.hass}
.stateObj=${this._preview}
></entity-preview-row>
${this._listeners?.time
? html`
<p>
${this.hass.localize("ui.dialogs.helper_settings.template.time")}
</p>
`
: nothing}
${!this._listeners
? nothing
: this._listeners.all
? html`
<p class="all_listeners">
${this.hass.localize(
"ui.dialogs.helper_settings.template.all_listeners"
)}
</p>
`
: this._listeners.domains.length || this._listeners.entities.length
? html`
<p>
${this.hass.localize(
"ui.dialogs.helper_settings.template.listeners"
)}
</p>
<ul>
${this._listeners.domains
.sort()
.map(
(domain) => html`
<li>
<b
>${this.hass.localize(
"ui.dialogs.helper_settings.template.domain"
)}</b
>: ${domain}
</li>
`
)}
${this._listeners.entities
.sort()
.map(
(entity_id) => html`
<li>
<b
>${this.hass.localize(
"ui.dialogs.helper_settings.template.entity"
)}</b
>: ${entity_id}
</li>
`
)}
</ul>
`
: !this._listeners.time
? html`<span class="all_listeners">
${this.hass.localize(
"ui.dialogs.helper_settings.template.no_listeners"
)}
</span>`
: nothing} `;
}

private _setPreview = (preview: TemplatePreview) => {
Expand All @@ -62,13 +125,15 @@ class FlowPreviewTemplate extends LitElement {
return;
}
this._error = undefined;
this._listeners = preview.listeners;
const now = new Date().toISOString();
this._preview = {
entity_id: `${this.stepId}.flow_preview`,
last_changed: now,
last_updated: now,
context: { id: "", parent_id: null, user_id: null },
...preview,
attributes: preview.attributes,
state: preview.state,
};
};

Expand Down
6 changes: 3 additions & 3 deletions src/panels/developer-tools/template/developer-tools-template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,9 @@ class HaPanelDevTemplate extends LitElement {
)}
</p>
`
: ""}
: nothing}
${!this._templateResult?.listeners
? ""
? nothing
: this._templateResult.listeners.all
? html`
<p class="all_listeners">
Expand Down Expand Up @@ -229,7 +229,7 @@ class HaPanelDevTemplate extends LitElement {
</ul>
`
: !this._templateResult?.listeners.time
? html` <span class="all_listeners">
? html`<span class="all_listeners">
${this.hass.localize(
"ui.panel.developer-tools.tabs.templates.no_listeners"
)}
Expand Down
8 changes: 8 additions & 0 deletions src/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1280,6 +1280,14 @@
"schedule": {
"delete": "Delete item?",
"confirm_delete": "Do you want to delete this item?"
},
"template": {
"time": "[%key:ui::panel::developer-tools::tabs::templates::time%]",
"all_listeners": "[%key:ui::panel::developer-tools::tabs::templates::all_listeners%]",
"no_listeners": "[%key:ui::panel::developer-tools::tabs::templates::no_listeners%]",
"listeners": "[%key:ui::panel::developer-tools::tabs::templates::listeners%]",
"entity": "[%key:ui::panel::developer-tools::tabs::templates::entity%]",
"domain": "[%key:ui::panel::developer-tools::tabs::templates::domain%]"
}
},
"options_flow": {
Expand Down
Loading