Display category dialog in category picker (#20234)

This commit is contained in:
Paul Bottein 2024-03-28 13:51:53 +01:00 committed by GitHub
parent b590b21183
commit 6b8f4e92a7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 96 additions and 88 deletions

View File

@ -12,8 +12,10 @@ import { customElement, property, state } from "lit/decorators";
import { fireEvent } from "../common/dom/fire_event"; import { fireEvent } from "../common/dom/fire_event";
import { import {
CategoryRegistryEntry, CategoryRegistryEntry,
createCategoryRegistryEntry,
deleteCategoryRegistryEntry, deleteCategoryRegistryEntry,
subscribeCategoryRegistry, subscribeCategoryRegistry,
updateCategoryRegistryEntry,
} from "../data/category_registry"; } from "../data/category_registry";
import { showConfirmationDialog } from "../dialogs/generic/show-dialog-box"; import { showConfirmationDialog } from "../dialogs/generic/show-dialog-box";
import { SubscribeMixin } from "../mixins/subscribe-mixin"; import { SubscribeMixin } from "../mixins/subscribe-mixin";
@ -174,6 +176,8 @@ export class HaFilterCategories extends SubscribeMixin(LitElement) {
showCategoryRegistryDetailDialog(this, { showCategoryRegistryDetailDialog(this, {
scope: this.scope!, scope: this.scope!,
entry: this._categories.find((cat) => cat.category_id === id), entry: this._categories.find((cat) => cat.category_id === id),
updateEntry: (updates) =>
updateCategoryRegistryEntry(this.hass, this.scope!, id, updates),
}); });
} }
@ -206,7 +210,11 @@ export class HaFilterCategories extends SubscribeMixin(LitElement) {
if (!this.scope) { if (!this.scope) {
return; return;
} }
showCategoryRegistryDetailDialog(this, { scope: this.scope }); showCategoryRegistryDetailDialog(this, {
scope: this.scope,
createEntry: (values) =>
createCategoryRegistryEntry(this.hass, this.scope!, values),
});
} }
private _expandedWillChange(ev) { private _expandedWillChange(ev) {

View File

@ -1,6 +1,6 @@
import "@material/mwc-button"; import "@material/mwc-button";
import { css, CSSResultGroup, html, LitElement, nothing } from "lit"; import { css, CSSResultGroup, html, LitElement, nothing } from "lit";
import { 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-alert";
import { createCloseHeading } from "../../../components/ha-dialog"; import { createCloseHeading } from "../../../components/ha-dialog";
@ -8,14 +8,14 @@ import "../../../components/ha-icon-picker";
import "../../../components/ha-settings-row"; import "../../../components/ha-settings-row";
import "../../../components/ha-textfield"; import "../../../components/ha-textfield";
import { import {
CategoryRegistryEntry,
CategoryRegistryEntryMutableParams, CategoryRegistryEntryMutableParams,
createCategoryRegistryEntry,
updateCategoryRegistryEntry,
} from "../../../data/category_registry"; } from "../../../data/category_registry";
import { haStyleDialog } from "../../../resources/styles"; import { haStyleDialog } from "../../../resources/styles";
import { HomeAssistant } from "../../../types"; import { HomeAssistant } from "../../../types";
import { CategoryRegistryDetailDialogParams } from "./show-dialog-category-registry-detail"; import { CategoryRegistryDetailDialogParams } from "./show-dialog-category-registry-detail";
@customElement("dialog-category-registry-detail")
class DialogCategoryDetail extends LitElement { class DialogCategoryDetail extends LitElement {
@property({ attribute: false }) public hass!: HomeAssistant; @property({ attribute: false }) public hass!: HomeAssistant;
@ -34,8 +34,13 @@ class DialogCategoryDetail extends LitElement {
): Promise<void> { ): Promise<void> {
this._params = params; this._params = params;
this._error = undefined; this._error = undefined;
this._name = this._params.entry ? this._params.entry.name : ""; if (this._params.entry) {
this._icon = this._params.entry?.icon || null; this._name = this._params.entry.name || "";
this._icon = this._params.entry.icon || null;
} else {
this._name = this._params.suggestedName || "";
this._icon = null;
}
await this.updateComplete; await this.updateComplete;
} }
@ -123,24 +128,16 @@ class DialogCategoryDetail extends LitElement {
private async _updateEntry() { private async _updateEntry() {
const create = !this._params!.entry; const create = !this._params!.entry;
this._submitting = true; this._submitting = true;
let newValue: CategoryRegistryEntry | undefined;
try { try {
const values: CategoryRegistryEntryMutableParams = { const values: CategoryRegistryEntryMutableParams = {
name: this._name.trim(), name: this._name.trim(),
icon: this._icon || (create ? undefined : null), icon: this._icon || (create ? undefined : null),
}; };
if (create) { if (create) {
await createCategoryRegistryEntry( newValue = await this._params!.createEntry!(values);
this.hass,
this._params!.scope,
values
);
} else { } else {
await updateCategoryRegistryEntry( newValue = await this._params!.updateEntry!(values);
this.hass,
this._params!.scope,
this._params!.entry!.category_id,
values
);
} }
this.closeDialog(); this.closeDialog();
} catch (err: any) { } catch (err: any) {
@ -150,6 +147,7 @@ class DialogCategoryDetail extends LitElement {
} finally { } finally {
this._submitting = false; this._submitting = false;
} }
return newValue;
} }
static get styles(): CSSResultGroup { static get styles(): CSSResultGroup {
@ -171,5 +169,3 @@ declare global {
"dialog-category-registry-detail": DialogCategoryDetail; "dialog-category-registry-detail": DialogCategoryDetail;
} }
} }
customElements.define("dialog-category-registry-detail", DialogCategoryDetail);

View File

@ -20,19 +20,20 @@ import {
createCategoryRegistryEntry, createCategoryRegistryEntry,
subscribeCategoryRegistry, subscribeCategoryRegistry,
} from "../../../data/category_registry"; } from "../../../data/category_registry";
import {
showAlertDialog,
showPromptDialog,
} from "../../../dialogs/generic/show-dialog-box";
import { SubscribeMixin } from "../../../mixins/subscribe-mixin"; import { SubscribeMixin } from "../../../mixins/subscribe-mixin";
import { HomeAssistant, ValueChangedEvent } from "../../../types"; import { HomeAssistant, ValueChangedEvent } from "../../../types";
import { showCategoryRegistryDetailDialog } from "./show-dialog-category-registry-detail";
type ScorableCategoryRegistryEntry = ScorableTextItem & CategoryRegistryEntry; type ScorableCategoryRegistryEntry = ScorableTextItem & CategoryRegistryEntry;
const ADD_NEW_ID = "___ADD_NEW___";
const NO_CATEGORIES_ID = "___NO_CATEGORIES___";
const ADD_NEW_SUGGESTION_ID = "___ADD_NEW_SUGGESTION___";
const rowRenderer: ComboBoxLitRenderer<CategoryRegistryEntry> = (item) => const rowRenderer: ComboBoxLitRenderer<CategoryRegistryEntry> = (item) =>
html`<ha-list-item html`<ha-list-item
graphic="icon" graphic="icon"
class=${classMap({ "add-new": item.category_id === "add_new" })} class=${classMap({ "add-new": item.category_id === ADD_NEW_ID })}
> >
${item.icon ${item.icon
? html`<ha-icon slot="graphic" .icon=${item.icon}></ha-icon>` ? html`<ha-icon slot="graphic" .icon=${item.icon}></ha-icon>`
@ -103,7 +104,7 @@ export class HaCategoryPicker extends SubscribeMixin(LitElement) {
const result = categories ? [...categories] : []; const result = categories ? [...categories] : [];
if (!result?.length) { if (!result?.length) {
result.push({ result.push({
category_id: "no_categories", category_id: NO_CATEGORIES_ID,
name: this.hass.localize( name: this.hass.localize(
"ui.components.category-picker.no_categories" "ui.components.category-picker.no_categories"
), ),
@ -116,7 +117,7 @@ export class HaCategoryPicker extends SubscribeMixin(LitElement) {
: [ : [
...result, ...result,
{ {
category_id: "add_new", category_id: ADD_NEW_ID,
name: this.hass.localize("ui.components.category-picker.add_new"), name: this.hass.localize("ui.components.category-picker.add_new"),
icon: "mdi:plus", icon: "mdi:plus",
}, },
@ -130,7 +131,12 @@ export class HaCategoryPicker extends SubscribeMixin(LitElement) {
(this._init && changedProps.has("_opened") && this._opened) (this._init && changedProps.has("_opened") && this._opened)
) { ) {
this._init = true; this._init = true;
const categories = this._getCategories(this._categories, this.noAdd); const categories = this._getCategories(this._categories, this.noAdd).map(
(label) => ({
...label,
strings: [label.name],
})
);
this.comboBox.items = categories; this.comboBox.items = categories;
this.comboBox.filteredItems = categories; this.comboBox.filteredItems = categories;
} }
@ -175,18 +181,30 @@ export class HaCategoryPicker extends SubscribeMixin(LitElement) {
filterString, filterString,
target.items || [] target.items || []
); );
if (!this.noAdd && filteredItems?.length === 0) { if (filteredItems?.length === 0) {
this._suggestion = filterString; if (this.noAdd) {
this.comboBox.filteredItems = [ this.comboBox.filteredItems = [
{ {
category_id: "add_new_suggestion", category_id: NO_CATEGORIES_ID,
name: this.hass.localize( name: this.hass.localize(
"ui.components.category-picker.add_new_sugestion", "ui.components.category-picker.no_categories"
{ name: this._suggestion } ),
), icon: null,
picture: null, },
}, ] as ScorableCategoryRegistryEntry[];
]; } else {
this._suggestion = filterString;
this.comboBox.filteredItems = [
{
category_id: ADD_NEW_SUGGESTION_ID,
name: this.hass.localize(
"ui.components.category-picker.add_new_sugestion",
{ name: this._suggestion }
),
icon: "mdi:plus",
},
];
}
} else { } else {
this.comboBox.filteredItems = filteredItems; this.comboBox.filteredItems = filteredItems;
} }
@ -204,11 +222,11 @@ export class HaCategoryPicker extends SubscribeMixin(LitElement) {
ev.stopPropagation(); ev.stopPropagation();
let newValue = ev.detail.value; let newValue = ev.detail.value;
if (newValue === "no_categories") { if (newValue === NO_CATEGORIES_ID) {
newValue = ""; newValue = "";
} }
if (!["add_new_suggestion", "add_new"].includes(newValue)) { if (![ADD_NEW_SUGGESTION_ID, ADD_NEW_ID].includes(newValue)) {
if (newValue !== this._value) { if (newValue !== this._value) {
this._setValue(newValue); this._setValue(newValue);
} }
@ -216,54 +234,30 @@ export class HaCategoryPicker extends SubscribeMixin(LitElement) {
} }
(ev.target as any).value = this._value; (ev.target as any).value = this._value;
showPromptDialog(this, {
title: this.hass.localize( showCategoryRegistryDetailDialog(this, {
"ui.components.category-picker.add_dialog.title" scope: this.scope!,
), suggestedName: newValue === ADD_NEW_SUGGESTION_ID ? this._suggestion : "",
text: this.hass.localize("ui.components.category-picker.add_dialog.text"), createEntry: async (values) => {
confirmText: this.hass.localize( const category = await createCategoryRegistryEntry(
"ui.components.category-picker.add_dialog.add" this.hass,
), this.scope!,
inputLabel: this.hass.localize( values
"ui.components.category-picker.add_dialog.name" );
), this._categories = [...this._categories!, category];
defaultValue: this.comboBox.filteredItems = this._getCategories(
newValue === "add_new_suggestion" ? this._suggestion : undefined, this._categories,
confirm: async (name) => { this.noAdd
if (!name) { );
return; await this.updateComplete;
} await this.comboBox.updateComplete;
try { this._setValue(category.category_id);
const category = await createCategoryRegistryEntry( return category;
this.hass,
this.scope!,
{
name,
}
);
this._categories = [...this._categories!, category];
this.comboBox.filteredItems = this._getCategories(
this._categories,
this.noAdd
);
await this.updateComplete;
await this.comboBox.updateComplete;
this._setValue(category.category_id);
} catch (err: any) {
showAlertDialog(this, {
title: this.hass.localize(
"ui.components.category-picker.add_dialog.failed_create_category"
),
text: err.message,
});
}
},
cancel: () => {
this._setValue(undefined);
this._suggestion = undefined;
this.comboBox.setInputValue("");
}, },
}); });
this._suggestion = undefined;
this.comboBox.setInputValue("");
} }
private _setValue(value?: string) { private _setValue(value?: string) {

View File

@ -1,9 +1,19 @@
import { fireEvent } from "../../../common/dom/fire_event"; import { fireEvent } from "../../../common/dom/fire_event";
import { CategoryRegistryEntry } from "../../../data/category_registry"; import {
CategoryRegistryEntry,
CategoryRegistryEntryMutableParams,
} from "../../../data/category_registry";
export interface CategoryRegistryDetailDialogParams { export interface CategoryRegistryDetailDialogParams {
entry?: CategoryRegistryEntry; entry?: CategoryRegistryEntry;
scope: string; scope: string;
suggestedName?: string;
createEntry?: (
values: CategoryRegistryEntryMutableParams
) => Promise<CategoryRegistryEntry>;
updateEntry?: (
updates: Partial<CategoryRegistryEntryMutableParams>
) => Promise<CategoryRegistryEntry>;
} }
export const loadCategoryRegistryDetailDialog = () => export const loadCategoryRegistryDetailDialog = () =>