V15: Document Type Create Options #17669

leekelleher · 2024-11-28T12:20:12Z

Description

Creates an entityCreateOptionAction extension for each of the Document Type create actions. This builds on the work started in umbraco/Umbraco.CMS.Backoffice#2509, and replaces the existing "Document Type Create Options modal" (which has hardcoded options).

To align the UI/UX consistency for the existing Create Options, amends were required to the <umb-ref-item> component, (refactored to extend uui-ref-node rather than duplicate code/functionality). This mostly meant updating existing usage to add the select-only attribute.

// @madsrasmussen Tagging you in, as you may wish to cast an eye on these amends.

How to test?

Go to the Settings section, try creating a new document type:

Does the create modal appear?
Does it have any options?
Do they work?

To extend, rather than reinvent the wheel.

…item` instead of `uui-ref-node`, so we can use `umb-icon` (with color support) and UI consistency.

Deprecates `umb-document-type-create-options-modal` and token.

- Document Type (default) - Document Type with Template - Element Type - Folder

nielslyngsoe · 2024-11-28T13:47:42Z

src/Umbraco.Web.UI.Client/src/packages/core/components/ref-item/ref-item.element.ts

+		if (this.icon) {
+			const umbIcon = document.createElement('umb-icon');
+			umbIcon.setAttribute('name', this.icon);
+			this.shadowRoot?.querySelector('#icon')?.replaceWith(umbIcon);


I think this is a little dangerous,, cause what if something caused Lit to re-render.. then it would not be overriden any more..

Could you try to just add it as a direct child, not in the shadowRoot and then set the attribute slot='icon'?

It felt a bit hacky when I was developing that part. I did try a few other approaches, but I couldn't get the icon to display, the fallback icon kept being rendered.

For reference: https://github.com/umbraco/Umbraco.UI/blob/v1.12.2/packages/uui-ref-node/lib/uui-ref-node.element.ts#L109-L112

When you say "add it as a direct child", do you mean that it overrides the render() method? If so, I'm not quite sure how that would work.

I'm wondering if UUIRefNodeElement could have a protected renderIcon() method added to it, that may simplify this. 🤔

I have changed this to append a child of it self. This can later be updated to override a method.

nielslyngsoe · 2024-11-28T13:48:55Z

src/Umbraco.Web.UI.Client/src/packages/core/components/ref-item/ref-item.element.ts

-
-	@property({ type: String })
-	detail = '';
+const elementName = 'umb-ref-item';


I think we agreed not to do this any longer? :-D

I thought we agreed the opposite, that we would do this. 😂 I'm cool with reverting this, just let me know.

yeah, well the idea is to get rid of it in time. so I would say yes, lets not add it in this PR. :-)

I have corrected this

nielslyngsoe · 2024-11-28T13:51:39Z

Hi @leekelleher really great refactoring, that is so nice to get aligned and make extendable. so thanks for that. I just skimmed the code of interest, so not because I'm reviewing per say, but I had two minor comments :-)

madsrasmussen · 2024-11-28T20:33:45Z

Hi @leekelleher ,

It's fantastic to see that you have implemented the create options for Document Types. This is one of the more interesting cases! :D

Based on the current state of your PR, I would appreciate it if we could address these areas to ensure maximum flexibility for extensions and at the same time decouple our own code more. I suggest we move all template logic from the Document Type into the "Template"-module. This means that if the template package is not installed, all related logic around Document Types with templates would be removed (headless cms):

The "Document Type with Template"-create option should be registered within the "template"-module.
We need to find a solution for the hardcoded presets inside the Document Type workspace. Having these hardcoded limits the possibilities for the create option extension. One potential solution could be to introduce another extension point for "presets." A create option could pass a preset extension alias to the workspace, allowing the workspace to find the registered preset and execute any related logic.
Register the template workspace view from the template module, but I don’t think that’s directly relevant to this PR.

As we work on these changes, we should also consider how to implement a solution that can be reused across all workspaces. We already have a snippet/preset functionality for Partials Views which could utilize the same system.

nielslyngsoe · 2025-01-06T14:51:00Z

...s/document-types/entity-actions/create/default/default-document-type-create-option-action.ts

+import type { MetaEntityCreateOptionAction } from '@umbraco-cms/backoffice/entity-create-option-action';
+
+export class UmbDefaultDocumentTypeCreateOptionAction extends UmbEntityCreateOptionActionBase<MetaEntityCreateOptionAction> {
+	override async execute() {


Since we are generating a HREF/URL, then we should not use an exeucte method, but instead use the getHref method. so the actual URL is exposed to the user and the user can use such to open in a new tab etc. More transparent and accessible. I have corrected this.

nielslyngsoe · 2025-01-06T14:52:17Z

...nts/document-types/entity-actions/create/folder/document-type-folder-create-option-action.ts

+	override async execute() {
+		if (!this.args.entityType) throw new Error('Entity type is required to create a folder');
+
+		const createFolderAction = new UmbCreateFolderEntityAction(this, {


I have also changed this to use inheritance instead

nielslyngsoe · 2025-01-06T14:54:54Z

I have been through this code changes and a bit related code to correct a few things. I have added comments on each change so its clear and we can discuss if necessary. Feel free to let me know what you think, and then I hope this will help move this PR forward :-)

@madsrasmussen do you have some structural changes you like to take part of this PR. I like your idea but I'm unsure if it fits within this PR. Your call, I'm open for the inputs :-)

madsrasmussen · 2025-01-07T11:56:48Z

FYI: I have removed the custom headline option for the create dialog. I would like to solve this in a more generic way so the dialog will handle it. It could be showing a breadcrumb of where something will be created. We will have to live with a general "Create" text for now. I hope it makes sense.

madsrasmussen

Hi Hi,

I think we have all been over this now, so let's get it merged 😄

Everything works as expected 👍
We have removed code duplication by using an extension point 👍

My dream for code splitting and extendable presets will be for another PR.

Awesome work 💯

leekelleher added 7 commits November 28, 2024 11:45

Refactors umb-ref-item to inherit from uui-ref-node

8d10918

To extend, rather than reinvent the wheel.

Updates components using umb-ref-item with select-only attribute

3f90567

Updates umb-entity-create-option-action-list-modal to use `umb-ref-…

f4ebd41

…item` instead of `uui-ref-node`, so we can use `umb-icon` (with color support) and UI consistency.

Adds headline property for Create Option modal

8a8d801

Changes 'Umb.EntityAction.DocumentType.Create' to use kind: 'create'

c09bb43

Deprecates `umb-document-type-create-options-modal` and token.

Adds entityCreateOptionAction extensions for Document Types

1cf6fdc

- Document Type (default) - Document Type with Template - Element Type - Folder

Tweaks Create Options modal to submit upon selection

e3ce39c

leekelleher added the type/feature label Nov 28, 2024

leekelleher requested review from iOvergaard and madsrasmussen November 28, 2024 12:20

nielslyngsoe reviewed Nov 28, 2024

View reviewed changes

nielslyngsoe and others added 2 commits November 29, 2024 11:25

Merge branch 'v15/dev' into v15/feature/doctype-create-options

d14a9e5

Merge branch 'v15/dev' into v15/feature/doctype-create-options

33d49d7

nielslyngsoe reviewed Jan 6, 2025

View reviewed changes

corrections

2a1f143

nielslyngsoe reviewed Jan 6, 2025

View reviewed changes

Merge branch 'v15/dev' into v15/feature/doctype-create-options

172b48e

nielslyngsoe removed the request for review from iOvergaard January 7, 2025 06:36

madsrasmussen added the area/frontend label Jan 7, 2025

madsrasmussen self-assigned this Jan 7, 2025

remove headline option

9f676e6

madsrasmussen approved these changes Jan 7, 2025

View reviewed changes

iOvergaard enabled auto-merge January 7, 2025 12:15

iOvergaard disabled auto-merge January 7, 2025 12:18

iOvergaard enabled auto-merge (squash) January 7, 2025 12:18

iOvergaard added the release/15.2.0 label Jan 7, 2025

iOvergaard merged commit 1fdf32f into v15/dev Jan 7, 2025
29 checks passed

iOvergaard deleted the v15/feature/doctype-create-options branch January 7, 2025 12:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

V15: Document Type Create Options #17669

V15: Document Type Create Options #17669

leekelleher commented Nov 28, 2024

nielslyngsoe Nov 28, 2024 •

edited

Loading

leekelleher Nov 28, 2024

nielslyngsoe Jan 6, 2025

nielslyngsoe Nov 28, 2024

leekelleher Nov 28, 2024

nielslyngsoe Nov 29, 2024

nielslyngsoe Jan 6, 2025

nielslyngsoe commented Nov 28, 2024

madsrasmussen commented Nov 28, 2024 •

edited

Loading

nielslyngsoe Jan 6, 2025

nielslyngsoe Jan 6, 2025

nielslyngsoe commented Jan 6, 2025

madsrasmussen commented Jan 7, 2025

madsrasmussen left a comment

V15: Document Type Create Options #17669

V15: Document Type Create Options #17669

Conversation

leekelleher commented Nov 28, 2024

Description

How to test?

nielslyngsoe Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nielslyngsoe commented Nov 28, 2024

madsrasmussen commented Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nielslyngsoe commented Jan 6, 2025

madsrasmussen commented Jan 7, 2025

madsrasmussen left a comment

Choose a reason for hiding this comment

nielslyngsoe Nov 28, 2024 •

edited

Loading

madsrasmussen commented Nov 28, 2024 •

edited

Loading