Skip to content

DashboardApps: Added sorting, defaults to all dashboard apps #19734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v16/poc/dashboard-apps
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
import type { ManifestDashboardApp } from '../dashboard-app.extension.js';
import { UMB_DASHBOARD_APP_PICKER_MODAL } from '../app/picker/picker-modal.token.js';
import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
import { css, html, customElement, nothing, ifDefined, state, repeat } from '@umbraco-cms/backoffice/external/lit';
import { css, html, customElement, nothing, ifDefined, state, repeat, styleMap } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
import {
UmbExtensionsElementInitializer,
type UmbExtensionElementInitializer,
} from '@umbraco-cms/backoffice/extension-api';
import { umbOpenModal } from '@umbraco-cms/backoffice/modal';
import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry';
import { UUIBlinkAnimationValue, UUIBlinkKeyframes } from '@umbraco-cms/backoffice/external/uui';
import type { DashboardAppInstance } from './types.js';
import { UmbSorterController } from '@umbraco-cms/backoffice/sorter';
import { UmbId } from '@umbraco-cms/backoffice/id';

@customElement('umb-dashboard')
export class UmbDashboardElement extends UmbLitElement {
Expand All @@ -20,16 +24,41 @@
['large', 'large'],
]);

#gridSizeMap = new Map([
['small',{columns:1, rows: 1}],
['medium',{columns:2, rows: 2}],
['large',{columns:2, rows: 2}],
]);

#sorter? : UmbSorterController<DashboardAppInstance>;

#extensionsController?: UmbExtensionsElementInitializer<UmbExtensionManifest, 'dashboardApp', ManifestDashboardApp>;

@state()
_appElements: Array<any> = [];
_appElements: Array<DashboardAppInstance> = [];

@state()
_appUniques: Array<string> = [];

constructor() {
super();

this.#sorter = new UmbSorterController<DashboardAppInstance>(this, {
itemSelector: '.dashboard-app',
containerSelector: '.grid-container',
getUniqueOfElement: (element) => element.getAttribute('data-sorter-id'),
getUniqueOfModel: (modelEntry) => modelEntry.key,
onChange: ({ model }) => {
const oldValue = this._appElements;
this._appElements = model;
this.requestUpdate('_appElements', oldValue);
},
});

this.#sorter.setModel(this._appElements);

this.#observeDashboardApps();

}

#observeDashboardApps(): void {
Expand All @@ -42,22 +71,45 @@
this,
umbExtensionsRegistry,
'dashboardApp',
(manifest) => this._appUniques.includes(manifest.alias),
// If no _appUniques, return all
(manifest) => this._appUniques.length == 0 || this._appUniques.includes(manifest.alias),
(extensionControllers) => {
this._appElements = extensionControllers.map((controller) => {

let newAppElements : DashboardAppInstance[] = [];

extensionControllers.forEach((controller)=>{

if (controller.component && controller.manifest) {
const size = this.#sizeMap.get(controller.manifest.meta?.size) ?? this.#defaultSize;
const headline = controller.manifest?.meta?.headline
? this.localize.string(controller.manifest?.meta?.headline)
: undefined;

return html`<uui-box part="umb-dashboard-app-${size}" headline=${ifDefined(headline)}
>${controller.component}</uui-box
>`;
let gridSize = this.#gridSizeMap.get(size)!;

newAppElements.push({
key : UmbId.new(),
columns : gridSize.columns,
rows : gridSize?.rows,
headline : headline,
component : controller.component,
});


} else {
return html`<uui-box part="umb-dashboard-app-${this.#defaultSize}">Not Found</uui-box>`;
newAppElements.push({
key : UmbId.new(),
columns : 1,
rows : 1,
}
);
}
});

this._appElements = newAppElements;

this.#sorter?.setModel(this._appElements);

},
undefined, // We can leave the alias to undefined, as we destroy this our selfs.
);
Expand Down Expand Up @@ -86,60 +138,109 @@
<div class="grid-container">
${repeat(
this._appElements,
(element) => element,
(element) => element,
(element) => element.key,
(element) =>
html`
<div
style=${styleMap({gridColumn:`span ${element.columns}`,gridRow:`span ${element.rows}`})}
class="dashboard-app"
data-sorter-id=${element.key}>
<uui-box headline=${element.headline ?? ""}>
${element.component}
</uui-box>
</div>`,
)}
</div>
<umb-extension-slot
type="dashboardApp"
.renderMethod=${this.#extensionSlotRenderMethod}
class="grid-container"></umb-extension-slot>
</section>
`;
}

Check notice on line 157 in src/Umbraco.Web.UI.Client/src/packages/core/dashboard/default/dashboard.element.ts

View check run for this annotation

CodeScene Delta Analysis / CodeScene Cloud Delta Analysis (v16/poc/dashboard-apps)

✅ No longer an issue: Complex Method

UmbDashboardElement.extensionSlotRenderMethod is no longer above the threshold for cyclomatic complexity. This function has many conditional statements (e.g. if, for, while), leading to lower code health. Avoid adding more conditionals and code to it without refactoring.
#extensionSlotRenderMethod = (ext: UmbExtensionElementInitializer<ManifestDashboardApp>) => {
if (ext.component && ext.manifest) {
const size = this.#sizeMap.get(ext.manifest.meta?.size) ?? this.#defaultSize;
const headline = ext.manifest?.meta?.headline ? this.localize.string(ext.manifest?.meta?.headline) : undefined;
return html`<uui-box part="umb-dashboard-app-${size}" headline=${ifDefined(headline)}>${ext.component}</uui-box>`;
}

return nothing;
};

static override styles = [
UmbTextStyles,
css`
:host {
container-type: inline-size;
}

uui-box {
height:100%;
position:relative;
}

#content {
padding: var(--uui-size-layout-1);
container-type: inline-size;
}

.grid-container {
margin-top:var(--uui-size-layout-1);
display: grid;
grid-template-columns: repeat(4, 1fr);
//grid-template-rows: repeat(100, 225px);
margin: calc(var(--uui-size-space-3) * -1);
margin-bottom: 20px;
grid-auto-rows: 225px;
gap: 20px;
}

@container (inline-size < 900px) {
.grid-container {
grid-template-columns: repeat(3, 1fr);
}
}

@container (inline-size < 601px) {
.grid-container {
grid-template-columns: repeat(1, 1fr);
}
.grid-container > * {
grid-column: span 1 !important;
}
}

umb-extension-slot::part(umb-dashboard-app-small) {
grid-column: span 1;
grid-row: span 1;
margin: var(--uui-size-space-3);
.dashboard-app {
position:relative;
display:block;
height:100%;
}

umb-extension-slot::part(umb-dashboard-app-medium) {
grid-column: span 2;
grid-row: span 2;
margin: var(--uui-size-space-3);
.dashboard-app::after {
content: '';
position: absolute;
z-index: 1;
pointer-events: none;
inset: 0;
border: 1px solid transparent;
border-radius: var(--uui-border-radius);

transition: border-color 240ms ease-in;
}

umb-extension-slot::part(umb-dashboard-app-large) {
grid-column: span 2;
grid-row: span 3;
margin: var(--uui-size-space-3);
.dashboard-app[drag-placeholder] {
position: relative;
display: block;
--umb-block-grid-entry-actions-opacity: 0;
}

.dashboard-app[drag-placeholder]::after {
display: block;
border-width: 2px;
border-color: var(--uui-color-interactive-emphasis);
animation: ${UUIBlinkAnimationValue};
}

.dashboard-app[drag-placeholder]::before {
content: '';
position: absolute;
pointer-events: none;
inset: 0;
border-radius: var(--uui-border-radius);
background-color: var(--uui-color-interactive-emphasis);
opacity: 0.12;
}

.dashboard-app[drag-placeholder] > * {
transition: opacity 50ms 16ms;
opacity: 0;
}

`,
];
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ export interface MetaDashboardDefaultKind extends MetaDashboard {
headline: string;
}

export interface DashboardAppInstance {
key? : string;
rows? : number;
columns? : number;
headline? : string;
component? : HTMLElement;
}

declare global {
interface UmbExtensionManifestMap {
umbManifestDashboardDefaultKind: ManifestDashboardDefaultKind;
Expand Down