From b387641a22bf9f9a220d03f2419eede9ca10d625 Mon Sep 17 00:00:00 2001
From: leekelleher <leekelleher@gmail.com>
Date: Tue, 14 May 2024 11:26:22 +0100
Subject: [PATCH] CheckboxList property-editor: support name/value option data

---
 .../input-checkbox-list.element.ts            | 13 +++----
 ...roperty-editor-ui-checkbox-list.element.ts | 34 +++++++++++++------
 2 files changed, 30 insertions(+), 17 deletions(-)

diff --git a/src/Umbraco.Web.UI.Client/src/packages/property-editors/checkbox-list/components/input-checkbox-list/input-checkbox-list.element.ts b/src/Umbraco.Web.UI.Client/src/packages/property-editors/checkbox-list/components/input-checkbox-list/input-checkbox-list.element.ts
index 55c17a169e..abda4ede6b 100644
--- a/src/Umbraco.Web.UI.Client/src/packages/property-editors/checkbox-list/components/input-checkbox-list/input-checkbox-list.element.ts
+++ b/src/Umbraco.Web.UI.Client/src/packages/property-editors/checkbox-list/components/input-checkbox-list/input-checkbox-list.element.ts
@@ -4,11 +4,12 @@ import { UmbChangeEvent } from '@umbraco-cms/backoffice/event';
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import type { UUIBooleanInputEvent } from '@umbraco-cms/backoffice/external/uui';
 
+type UmbCheckboxListItem = { label: string; value: string; checked: boolean };
+
 @customElement('umb-input-checkbox-list')
 export class UmbInputCheckboxListElement extends UUIFormControlMixin(UmbLitElement, '') {
-	// TODO: Could this use a type that we export to ensure TS failure, or hook this up with a type coming from backend?
 	@property({ attribute: false })
-	public list: Array<{ label: string; value: string; checked: boolean }> = [];
+	public list: Array<UmbCheckboxListItem> = [];
 
 	#selection: Array<string> = [];
 	@property({ type: Array })
@@ -29,10 +30,10 @@ export class UmbInputCheckboxListElement extends UUIFormControlMixin(UmbLitEleme
 		return undefined;
 	}
 
-	#onChange(e: UUIBooleanInputEvent) {
-		e.stopPropagation();
-		if (e.target.checked) this.selection = [...this.selection, e.target.value];
-		else this.#removeFromSelection(this.selection.findIndex((value) => e.target.value === value));
+	#onChange(event: UUIBooleanInputEvent) {
+		event.stopPropagation();
+		if (event.target.checked) this.selection = [...this.selection, event.target.value];
+		else this.#removeFromSelection(this.selection.findIndex((value) => event.target.value === value));
 
 		this.dispatchEvent(new UmbChangeEvent());
 	}
diff --git a/src/Umbraco.Web.UI.Client/src/packages/property-editors/checkbox-list/property-editor-ui-checkbox-list.element.ts b/src/Umbraco.Web.UI.Client/src/packages/property-editors/checkbox-list/property-editor-ui-checkbox-list.element.ts
index 1341fde46e..ca6226ee2a 100644
--- a/src/Umbraco.Web.UI.Client/src/packages/property-editors/checkbox-list/property-editor-ui-checkbox-list.element.ts
+++ b/src/Umbraco.Web.UI.Client/src/packages/property-editors/checkbox-list/property-editor-ui-checkbox-list.element.ts
@@ -12,26 +12,38 @@ import './components/input-checkbox-list/input-checkbox-list.element.js';
  */
 @customElement('umb-property-editor-ui-checkbox-list')
 export class UmbPropertyEditorUICheckboxListElement extends UmbLitElement implements UmbPropertyEditorUiElement {
-	#value: Array<string> = [];
+	#selection: Array<string> = [];
+
 	@property({ type: Array })
-	public set value(value: Array<string>) {
-		this.#value = value ?? [];
+	public set value(value: Array<string> | string | undefined) {
+		this.#selection = Array.isArray(value) ? value : value ? [value] : [];
 	}
-	public get value(): Array<string> {
-		return this.#value;
+	public get value(): Array<string> | undefined {
+		return this.#selection;
 	}
 
 	public set config(config: UmbPropertyEditorConfigCollection | undefined) {
-		const listData: string[] | undefined = config?.getValueByAlias('items');
-		this._list = listData?.map((item) => ({ label: item, value: item, checked: this.#value.includes(item) })) ?? [];
+		if (!config) return;
+
+		const items = config.getValueByAlias('items');
+
+		if (Array.isArray(items) && items.length > 0) {
+			this._list =
+				typeof items[0] === 'string'
+					? items.map((item) => ({ label: item, value: item, checked: this.#selection.includes(item) }))
+					: items.map((item) => ({
+							label: item.name,
+							value: item.value,
+							checked: this.#selection.includes(item.value),
+						}));
+		}
 	}
 
 	@state()
 	private _list: UmbInputCheckboxListElement['list'] = [];
 
-	#onChange(event: CustomEvent) {
-		const element = event.target as UmbInputCheckboxListElement;
-		this.value = element.selection;
+	#onChange(event: CustomEvent & { target: UmbInputCheckboxListElement }) {
+		this.value = event.target.selection;
 		this.dispatchEvent(new UmbPropertyValueChangeEvent());
 	}
 
@@ -39,7 +51,7 @@ export class UmbPropertyEditorUICheckboxListElement extends UmbLitElement implem
 		return html`
 			<umb-input-checkbox-list
 				.list=${this._list}
-				.selection=${this.#value}
+				.selection=${this.#selection}
 				@change=${this.#onChange}></umb-input-checkbox-list>
 		`;
 	}