Icon picker as property editor

[bjarnef]

Which Umbraco version are you using?

16.3.1

Bug summary

I am not sure if this is a bug or a missing feature.

However Umbraco has an icon picker in (e.g. used for content type icon and workspace icon.

https://github.com/umbraco/Umbraco-CMS/blob/3854b2bd53c76d639e3343691c04f812bcce7466/src/Umbraco.Web.UI.Client/src/packages/property-editors/icon-picker/manifests.ts

It seems to be exported like eye dropper:

Umbraco-CMS/src/Umbraco.Web.UI.Client/src/packages/property-editors/manifests.ts

Lines 33 to 34 in 3854b2b

	...eyeDropperManifests,
	...iconPickerManifests,

but isn't available to use:

The use-case is that we would like to re-use this a just use Lucide icons in frontend - and possible register more icons as it seem Umbraco only include as subset of the icons.

Alternatively can we import the existing icon picker registered to a custom property editor ui?

Ideally it would be nice if it is possibe to exclude, e.g. the social icons (from simple icons) mainly used for identity providers in core.

Specifics

No response

Steps to reproduce

Expected result / actual result

No response

[github-actions]

Hi there @bjarnef!

Firstly, a big thank you for raising this issue. Every piece of feedback we receive helps us to make Umbraco better.

We really appreciate your patience while we wait for our team to have a look at this but we wanted to let you know that we see this and share with you the plan for what comes next.

• We'll assess whether this issue relates to something that has already been fixed in a later version of the release that it has been raised for.
• If it's a bug, is it related to a release that we are actively supporting or is it related to a release that's in the end-of-life or security-only phase?
• We'll replicate the issue to ensure that the problem is as described.
• We'll decide whether the behavior is an issue or if the behavior is intended.

We wish we could work with everyone directly and assess your issue immediately but we're in the fortunate position of having lots of contributions to work with and only a few humans who are able to do it. We are making progress though and in the meantime, we will keep you in the loop and let you know when we have any questions.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

[bjarnef]

@nielslyngsoe is this expected the icon picker isn't available as property editor?
I wonder if we can make it flexible for various icon sets, e.g. Lucide, Iconoir, Font Awesome etc.

E.g. inspired from the package by @warrenbuckley :
https://marketplace.umbraco.com/package/umbraco.community.iconpack.iconoir

Maybe a foundation to extend from?

[bjarnef]

I found Umbraco.IconPicker here:

Umbraco-CMS/src/Umbraco.Web.UI.Client/src/mocks/data/data-type/data-type.data.ts

Lines 1045 to 1056 in 8434c7d

	name: 'Icon Picker',
	id: 'dt-iconPicker',
	parent: null,
	editorAlias: 'Umbraco.IconPicker',
	editorUiAlias: 'Umb.PropertyEditorUi.IconPicker',
	hasChildren: false,
	isFolder: false,
	isDeletable: true,
	canIgnoreStartNodes: false,
	flags: [],
	values: [],
	},

is that a mistake, sense there is no Umbraco.IconPicker here?
https://github.com/umbraco/Umbraco-CMS/blob/main/src/Umbraco.Core/Constants-PropertyEditors.cs

I tried to wrap inside my own component, but not sure where to import umb-property-editor-ui-icon-picker from, when not internal:

Umbraco-CMS/src/Umbraco.Web.UI.Client/src/packages/property-editors/icon-picker/property-editor-ui-icon-picker.test.ts

Line 1 in 8434c7d

import { UmbPropertyEditorUIIconPickerElement } from './property-editor-ui-icon-picker.element.js';

import { html, customElement } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
import type {
	UmbPropertyEditorUiElement,
} from '@umbraco-cms/backoffice/property-editor';

/**
 * @element mcb-property-editor-ui-icon-picker
 */
@customElement('mcb-property-editor-ui-icon-picker')
export class McbPropertyEditorUIIconPickerElement extends UmbLitElement implements UmbPropertyEditorUiElement {

	override render() {
		return html`
			<umb-property-editor-ui-icon-picker></umb-property-editor-ui-icon-picker>
		`;
	}
}

export default McbPropertyEditorUIIconPickerElement;

declare global {
	interface HTMLElementTagNameMap {
		'mcb-property-editor-ui-icon-picker': McbPropertyEditorUIIconPickerElement;
	}
}

[bjarnef]

@nielslyngsoe is it possible to import umb-property-editor-ui-icon-picker component in this context? In this example the it doesn't render the component :)

I can of course just implement most of the same logic from here in my own component:
https://github.com/umbraco/Umbraco-CMS/blob/8434c7d0cbf919532be72e0c86bfed5a3af66877/src/Umbraco.Web.UI.Client/src/packages/property-editors/icon-picker/property-editor-ui-icon-picker.element.ts

[bjarnef]

I found this in docs https://docs.umbraco.com/umbraco-cms/customizing/property-editors/integrate-property-editors and article from Matt here: https://mattbrailsford.dev/reusing-umbraco-properties-in-umbraco

plus an example in core here:

Umbraco-CMS/src/Umbraco.Web.UI.Client/src/packages/core/property/property-dataset/property-dataset.element.test.ts

Lines 12 to 54 in d9c201e

	_datasetContext?: typeof UMB_PROPERTY_DATASET_CONTEXT.TYPE;
	@property()
	public get alias() {
	return this._alias;
	}
	public set alias(value) {
	this._alias = value;
	this._observeProperty();
	}
	_alias?: string;
	@state()
	_value?: string;
	getValue() {
	return this._value;
	}
	setValue(value: string) {
	if (this._alias) {
	this._datasetContext?.setPropertyValue(this._alias, value);
	this.dispatchEvent(new UmbChangeEvent());
	}
	}
	protected async _observeProperty() {
	if (!this._datasetContext || !this._alias) return;
	this.observe(
	await this._datasetContext.propertyValueByAlias(this._alias),
	(value) => {
	this._value = value as string;
	},
	'observeValue',
	);
	}
	constructor() {
	super();
	this.consumeContext(UMB_PROPERTY_DATASET_CONTEXT, async (variantContext) => {
	this._datasetContext = variantContext;
	this._observeProperty();
	});
	}

import { html, customElement, property, state } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
import type {
	UmbPropertyEditorUiElement,
} from '@umbraco-cms/backoffice/property-editor';
import { UmbChangeEvent } from '@umbraco-cms/backoffice/event';
import { UMB_PROPERTY_DATASET_CONTEXT } from "@umbraco-cms/backoffice/property";

/**
 * @element mcb-property-editor-ui-icon-picker
 */
@customElement('mcb-property-editor-ui-icon-picker')
export class McbPropertyEditorUIIconPickerElement extends UmbLitElement implements UmbPropertyEditorUiElement {

	_datasetContext?: typeof UMB_PROPERTY_DATASET_CONTEXT.TYPE;

	@property()
	public get alias() {
		return this._alias;
	}
	public set alias(value) {
		this._alias = value;
		this._observeProperty();
	}
	_alias?: string;

	@state()
	_value?: string;

	getValue() {
		return this._value;
	}
	setValue(value: string) {
		if (this._alias) {
			this._datasetContext?.setPropertyValue(this._alias, value);
			this.dispatchEvent(new UmbChangeEvent());
		}
	}

	protected async _observeProperty() {
		if (!this._datasetContext || !this._alias) return;
		this.observe(
			await this._datasetContext.propertyValueByAlias(this._alias),
			(value) => {
				this._value = value as string;
			},
			'observeValue',
		);
	}

	constructor() {
		super();
		this.consumeContext(UMB_PROPERTY_DATASET_CONTEXT, async (variantContext) => {
			this._datasetContext = variantContext;
			this._observeProperty();
		});
	}

	override render() {
		return html`
			<umb-property-dataset>
				<umb-property
					alias=${this.alias}
					label="Test"
					description="Test Test"
					property-editor-ui-alias="Umb.PropertyEditorUi.IconPicker">
				</umb-property>
			</umb-property-dataset>
		`;
	}
}

export default McbPropertyEditorUIIconPickerElement;

declare global {
	interface HTMLElementTagNameMap {
		'mcb-property-editor-ui-icon-picker': McbPropertyEditorUIIconPickerElement;
	}
}

[umbracocommunity]

This issue has been mentioned on Umbraco community forum. There might be relevant details there:

https://forum.umbraco.com/t/re-use-icon-picker-property-editor/6455/1

[bjarnef]

For now I have copied most of the code from https://github.com/umbraco/Umbraco-CMS/blob/8434c7d0cbf919532be72e0c86bfed5a3af66877/src/Umbraco.Web.UI.Client/src/packages/property-editors/icon-picker/property-editor-ui-icon-picker.element.ts to my own component:

import { css, html, customElement, property, state, ifDefined } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
import type {
	UmbPropertyEditorConfigCollection,
	UmbPropertyEditorUiElement,
} from '@umbraco-cms/backoffice/property-editor';
import { UmbChangeEvent } from '@umbraco-cms/backoffice/event';

import { umbOpenModal } from '@umbraco-cms/backoffice/modal';
import { UMB_ICON_PICKER_MODAL } from '@umbraco-cms/backoffice/icon';
import { extractUmbColorVariable } from '@umbraco-cms/backoffice/resources';

import { UmbFormControlMixin } from '@umbraco-cms/backoffice/validation';

/**
 * @element mcb-property-editor-ui-icon-picker
 */
@customElement('mcb-property-editor-ui-icon-picker')
export class McbPropertyEditorUIIconPickerElement
	extends UmbFormControlMixin<string, typeof UmbLitElement, undefined>(UmbLitElement, undefined)
	implements UmbPropertyEditorUiElement {

	@property({ type: Boolean })
	mandatory = false;

	protected override firstUpdated(): void {
		this.addValidator(
			'valueMissing',
			() => 'Icon is required',
			() => this.mandatory && !this._icon,
		);
	}

	@property()
	public override set value(v: string) {
		const val = v ?? '';
		super.value = val;

		const parts = val.split(' ');
		if (parts.length === 2) {
			this._icon = parts[0];
			this._color = parts[1].replace('color-', '');
		} else {
			this._icon = val;
			this._color = '';
		}
	}

	public override get value() {
		return (super.value as string) ?? '';
	}

	@state()
	private _icon = '';

	@state()
	private _color = '';

	@state()
	private _placeholderIcon = '';

	public set config(config: UmbPropertyEditorConfigCollection | undefined) {
		if (!config) return;
		const placeholder = config.getValueByAlias('placeholder');
		this._placeholderIcon = typeof placeholder === 'string' ? placeholder : '';
	}

	private async _openModal() {
		const data = await umbOpenModal(this, UMB_ICON_PICKER_MODAL, {
			value: {
				icon: this._icon,
				color: this._color,
			},
			//data: { placeholder: this._placeholderIcon, showEmptyOption: !this.mandatory }, /* Not available yet */
		}).catch(() => undefined);

		if (!data) return;

		if (!data.icon) {
			this.value = '';
		} else if (data.color) {
			this.value = `${data.icon} color-${data.color}`;
		} else {
			this.value = data.icon as string;
		}

		this.dispatchEvent(new UmbChangeEvent());
	}

	override render() {
		const isEmpty = !this._icon;

		return html`
			<uui-button
				id="icon"
				compact
				look="outline"
				label=${this.localize.term('defaultdialogs_selectIcon')}
				@click=${this._openModal}>
				${isEmpty
				? html` <uui-icon name="${ifDefined(this._placeholderIcon)}" style="opacity:.35"></uui-icon> `
				: this._color
					? html`
								<uui-icon name="${this._icon}" style="color:var(${extractUmbColorVariable(this._color)})"> </uui-icon>
							`
					: html`<uui-icon name="${this._icon}"></uui-icon>`}
			</uui-button>
		`;
	}

	static override styles = [
		css`
            #icon {
				font-size: var(--uui-size-8);
				height: 60px;
				width: 60px;
			}
        `,
	];
	
}

export default McbPropertyEditorUIIconPickerElement;

declare global {
	interface HTMLElementTagNameMap {
		'mcb-property-editor-ui-icon-picker': McbPropertyEditorUIIconPickerElement;
	}
}

Ideally I think it would be great of Umbraco core included this as a property editor to use as well.
With changes from #20650 the property editor can have configurations to hide colors , set placeholder icon etc.

It would be great if it also can filter on a prefix, so an icon set registered can be used in component, when same icon set is used in frontend, eg. Lucide icons, but could be any other icon set.