Skip to content

Translated developer tools events page #4033

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

Merged
bramkragten merged 3 commits into from
Oct 17, 2019
Merged

Translated developer tools events page #4033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0169d5
Translated developer tools events page
springstan Oct 17, 2019
923cfe7
Implemented translations (alert on empty event type, notification on …
springstan Oct 17, 2019
4a1f602
Added falsely removed key-value pairs
springstan Oct 17, 2019
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
37 changes: 28 additions & 9 deletions src/panels/developer-tools/event/developer-tools-event.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ import "../../../resources/ha-style";
import "./events-list";
import "./event-subscribe-card";
import { EventsMixin } from "../../../mixins/events-mixin";
import LocalizeMixin from "../../../mixins/localize-mixin";

const ERROR_SENTINEL = {};
/*
* @appliesMixin EventsMixin
* @appliesMixin LocalizeMixin
*/
class HaPanelDevEvent extends EventsMixin(PolymerElement) {
class HaPanelDevEvent extends EventsMixin(LocalizeMixin(PolymerElement)) {
static get template() {
return html`
<style include="ha-style iron-flex iron-positioning"></style>
Expand Down Expand Up @@ -54,35 +56,44 @@ class HaPanelDevEvent extends EventsMixin(PolymerElement) {
<div class$="[[computeFormClasses(narrow)]]">
<div class="flex">
<p>
Fire an event on the event bus.
[[localize( 'ui.panel.developer-tools.tabs.events.description' )]]
<a
href="https://www.home-assistant.io/docs/configuration/events/"
target="_blank"
>Events Documentation.</a
>[[localize( 'ui.panel.developer-tools.tabs.events.documentation'
)]]</a
>
</p>
<div class="ha-form">
<paper-input
label="Event Type"
label="[[localize(
'ui.panel.developer-tools.tabs.events.type'
)]]"
autofocus
required
value="{{eventType}}"
></paper-input>
<p>Event Data (YAML, optional)</p>
<p>
[[localize( 'ui.panel.developer-tools.tabs.events.data' )]]
</p>
<ha-code-editor
mode="yaml"
value="[[eventData]]"
error="[[!validJSON]]"
on-value-changed="_yamlChanged"
></ha-code-editor>
<mwc-button on-click="fireEvent" raised disabled="[[!validJSON]]"
>Fire Event</mwc-button
>[[localize( 'ui.panel.developer-tools.tabs.events.fire_event'
)]]</mwc-button
>
</div>
</div>

<div>
<div class="header">Available Events</div>
<div class="header">
[[localize( 'ui.panel.developer-tools.tabs.events.available_events'
)]]
</div>
<events-list
on-event-selected="eventSelected"
hass="[[hass]]"
Expand Down Expand Up @@ -143,13 +154,21 @@ class HaPanelDevEvent extends EventsMixin(PolymerElement) {

fireEvent() {
if (!this.eventType) {
alert("Event type is a mandatory field");
alert(
this.hass.localize(
"ui.panel.developer-tools.tabs.events.alert_event_type"
)
);
return;
}
this.hass.callApi("POST", "events/" + this.eventType, this.parsedJSON).then(
function() {
this.fire("hass-notification", {
message: "Event " + this.eventType + " successful fired!",
message: this.hass.localize(
"ui.panel.developer-tools.tabs.events.notification_event_fired",
"type",
this.eventType
),
});
}.bind(this)
);
Expand Down
28 changes: 23 additions & 5 deletions src/panels/developer-tools/event/event-subscribe-card.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,20 @@ class EventSubscribeCard extends LitElement {

protected render(): TemplateResult {
return html`
<ha-card header="Listen to events">
<ha-card
header=${this.hass!.localize(
"ui.panel.developer-tools.tabs.events.listen_to_events"
)}
>
<form>
<paper-input
.label=${this._subscribed
? "Listening to"
: "Event to subscribe to"}
? this.hass!.localize(
"ui.panel.developer-tools.tabs.events.listening_to"
)
: this.hass!.localize(
"ui.panel.developer-tools.tabs.events.subscribe_to"
)}
.disabled=${this._subscribed !== undefined}
.value=${this._eventType}
@value-changed=${this._valueChanged}
Expand All @@ -52,14 +60,24 @@ class EventSubscribeCard extends LitElement {
@click=${this._handleSubmit}
type="submit"
>
${this._subscribed ? "Stop listening" : "Start listening"}
${this._subscribed
? this.hass!.localize(
"ui.panel.developer-tools.tabs.events.stop_listening"
)
: this.hass!.localize(
"ui.panel.developer-tools.tabs.events.start_listening"
)}
</mwc-button>
</form>
<div class="events">
${this._events.map(
(ev) => html`
<div class="event">
Event ${ev.id} fired
${this.hass!.localize(
"ui.panel.developer-tools.tabs.events.event_fired",
"name",
ev.id
)}
${format_time(
new Date(ev.event.time_fired),
this.hass!.language
Expand Down
11 changes: 8 additions & 3 deletions src/panels/developer-tools/event/events-list.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ import { html } from "@polymer/polymer/lib/utils/html-tag";
import { PolymerElement } from "@polymer/polymer/polymer-element";

import { EventsMixin } from "../../../mixins/events-mixin";
import LocalizeMixin from "../../../mixins/localize-mixin";

/*
* @appliesMixin EventsMixin
* @appliesMixin LocalizeMixin
*/
class EventsList extends EventsMixin(PolymerElement) {
class EventsList extends EventsMixin(LocalizeMixin(PolymerElement)) {
static get template() {
return html`
<style>
Expand All @@ -29,8 +31,11 @@ class EventsList extends EventsMixin(PolymerElement) {
<template is="dom-repeat" items="[[events]]" as="event">
<li>
<a href="#" on-click="eventSelected">{{event.event}}</a>
<span> (</span><span>{{event.listener_count}}</span
><span> listeners)</span>
<span>
[[localize(
"ui.panel.developer-tools.tabs.events.count_listeners", "count",
event.listener_count )]]</span
>
</li>
</template>
</ul>
Expand Down
17 changes: 16 additions & 1 deletion src/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1772,7 +1772,22 @@
"title": "Logs"
},
"events": {
"title": "Events"
"title": "Events",
"description": "Fire an event on the event bus.",
"documentation": "Events Documentation.",
"type": "Event Type",
"data": "Event Data (YAML, optional)",
"fire_event": "Fire Event",
"event_fired": "Event {name} fired",
"available_events": "Available Events",
"count_listeners": " ({count} listeners)",
"listen_to_events": "Listen to events",
"listening_to": "Listening to",
"subscribe_to": "Event to subscribe to",
"start_listening": "Start listening",
"stop_listening": "Stop listening",
"alert_event_type": "Event type is a mandatory field",
"notification_event_fired": "Event {type} successful fired!"
Copy link
Copy Markdown
Member

@bramkragten bramkragten Oct 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this one in your code?

Copy link
Copy Markdown
Member Author

@springstan springstan Oct 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh my bad. Not sure why I did not use start/stop_listening. Though I wanted to use alert_event_type and notification_event_fired in developer-tools-event.js here:

fireEvent() {
    if (!this.eventType) {
      alert("Event type is a mandatory field");
      return;
    }
    this.hass.callApi("POST", "events/" + this.eventType, this.parsedJSON).then(
      function() {
        this.fire("hass-notification", {
          message: "Event " + this.eventType + " successful fired!",
        });
      }.bind(this)
    );
  }

However, could not figure out how to use this.hass.localize() in this contex, the frontend always showed blank instead of the translated text.
Is there anything I have to take into account?

Copy link
Copy Markdown
Member

@bramkragten bramkragten Oct 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should work, what was your code?

Copy link
Copy Markdown
Member Author

@springstan springstan Oct 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what I did wrong before, but now it works flawlessly. Updated my code with 923cfe7.

},
"mqtt": {
"title": "MQTT"
Expand Down