jeans/frontend
jeans/frontend
1
0
Fork 0
mirror of https://github.com/home-assistant/frontend.git synced 2025-07-26 02:36:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow Markdown and description placeholder usage in data field descriptions (#13377)

Browse Source 
Co-authored-by: Zack Barett <zackbarett@hey.com>
This commit is contained in:
Franck Nijhof 2022-08-13 20:57:28 +02:00 committed by GitHub
parent 38607a6410
commit 651cafc464
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/dialogs/config-flow/show-dialog-config-flow.ts
View File

@ -89,9 +89,13 @@ export const showConfigFlowDialog = (
}, },
renderShowFormStepFieldHelper(hass, step, field) { renderShowFormStepFieldHelper(hass, step, field) {
return hass.localize( const description = hass.localize(
`component.${step.handler}.config.step.${step.step_id}.data_description.${field.name}` `component.${step.handler}.config.step.${step.step_id}.data_description.${field.name}`,
step.description_placeholders
); );
return description
? html`<ha-markdown breaks .content=${description}></ha-markdown>`
: "";
}, },
renderShowFormStepFieldError(hass, step, error) { renderShowFormStepFieldError(hass, step, error) {

2
src/dialogs/config-flow/show-dialog-data-entry-flow.ts
View File

@ -61,7 +61,7 @@ export interface FlowConfig {
hass: HomeAssistant, hass: HomeAssistant,
step: DataEntryFlowStepForm, step: DataEntryFlowStepForm,
field: HaFormSchema field: HaFormSchema
): string; ): TemplateResult | string;
renderShowFormStepFieldError( renderShowFormStepFieldError(
hass: HomeAssistant, hass: HomeAssistant,

8
src/dialogs/config-flow/show-dialog-options-flow.ts
View File

@ -93,9 +93,13 @@ export const showOptionsFlowDialog = (
}, },
renderShowFormStepFieldHelper(hass, step, field) { renderShowFormStepFieldHelper(hass, step, field) {
return hass.localize( const description = hass.localize(
`component.${configEntry.domain}.options.step.${step.step_id}.data_description.${field.name}` `component.${configEntry.domain}.options.step.${step.step_id}.data_description.${field.name}`,
step.description_placeholders
); );
return description
? html`<ha-markdown breaks .content=${description}></ha-markdown>`
: "";
}, },
renderShowFormStepFieldError(hass, step, error) { renderShowFormStepFieldError(hass, step, error) {

6
src/dialogs/config-flow/step-flow-form.ts
View File

@ -10,12 +10,12 @@ import {
} from "lit"; } from "lit";
import { customElement, property, state } from "lit/decorators"; import { customElement, property, state } from "lit/decorators";
import { fireEvent } from "../../common/dom/fire_event"; import { fireEvent } from "../../common/dom/fire_event";
import "../../components/ha-alert";
import "../../components/ha-circular-progress"; import "../../components/ha-circular-progress";
import { computeInitialHaFormData } from "../../components/ha-form/compute-initial-ha-form-data"; import { computeInitialHaFormData } from "../../components/ha-form/compute-initial-ha-form-data";
import type { HaFormSchema } from "../../components/ha-form/types";
import "../../components/ha-form/ha-form"; import "../../components/ha-form/ha-form";
import type { HaFormSchema } from "../../components/ha-form/types";
import "../../components/ha-markdown"; import "../../components/ha-markdown";
import "../../components/ha-alert";
import type { DataEntryFlowStepForm } from "../../data/data_entry_flow"; import type { DataEntryFlowStepForm } from "../../data/data_entry_flow";
import type { HomeAssistant } from "../../types"; import type { HomeAssistant } from "../../types";
import type { FlowConfig } from "./show-dialog-data-entry-flow"; import type { FlowConfig } from "./show-dialog-data-entry-flow";
@ -167,7 +167,7 @@ class StepFlowForm extends LitElement {
private _labelCallback = (field: HaFormSchema): string => private _labelCallback = (field: HaFormSchema): string =>
this.flowConfig.renderShowFormStepFieldLabel(this.hass, this.step, field); this.flowConfig.renderShowFormStepFieldLabel(this.hass, this.step, field);
private _helperCallback = (field: HaFormSchema): string => private _helperCallback = (field: HaFormSchema): string | TemplateResult =>
this.flowConfig.renderShowFormStepFieldHelper(this.hass, this.step, field); this.flowConfig.renderShowFormStepFieldHelper(this.hass, this.step, field);
private _errorCallback = (error: string) => private _errorCallback = (error: string) =>

8
src/panels/config/repairs/show-dialog-repair-flow.ts
View File

@ -100,11 +100,15 @@ export const showRepairsFlowDialog = (
}, },
renderShowFormStepFieldHelper(hass, step, field) { renderShowFormStepFieldHelper(hass, step, field) {
return hass.localize( const description = hass.localize(
`component.${issue.domain}.issues.${ `component.${issue.domain}.issues.${
issue.translation_key || issue.issue_id issue.translation_key || issue.issue_id
}.fix_flow.step.${step.step_id}.data_description.${field.name}` }.fix_flow.step.${step.step_id}.data_description.${field.name}`,
step.description_placeholders
); );
return description
? html`<ha-markdown breaks .content=${description}></ha-markdown>`
: "";
}, },
renderShowFormStepFieldError(hass, step, error) { renderShowFormStepFieldError(hass, step, error) {