Skip to content
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

feat: provide page structure tree information for the Design View #1577

Merged
merged 1 commit into from
May 8, 2024
Merged
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
42 changes: 38 additions & 4 deletions src/app/core/utils/design-view/design-view.service.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { ApplicationRef, Injectable } from '@angular/core';
import { NavigationEnd, Router } from '@angular/router';
import { Store, select } from '@ngrx/store';
import { filter, first, fromEvent, map, switchMap } from 'rxjs';
import { filter, first, fromEvent, map, switchMap, tap } from 'rxjs';

import { getCurrentLocale } from 'ish-core/store/core/configuration';
import { DomService } from 'ish-core/utils/dom/dom.service';
Expand All @@ -14,7 +14,8 @@ interface DesignViewMessage {
| 'dv-clientReady'
| 'dv-clientRefresh'
| 'dv-clientLocale'
| 'dv-clientStable';
| 'dv-clientStable'
| 'dv-clientContentIds';
// eslint-disable-next-line @typescript-eslint/no-explicit-any
payload?: any;
}
Expand Down Expand Up @@ -97,10 +98,18 @@ export class DesignViewService {
const navigationStable$ = navigation$.pipe(switchMap(() => stable$));

// send `dv-clientNavigation` event for each route change
navigation$.subscribe(e => this.messageToHost({ type: 'dv-clientNavigation', payload: { url: e.url } }));
navigation$
.pipe(
tap(e => this.messageToHost({ type: 'dv-clientNavigation', payload: { url: e.url } })),
switchMap(() => this.appRef.isStable.pipe(whenTruthy(), first()))
)
.subscribe(() => {
this.sendContentIds();
});

stable$.subscribe(() => {
this.applyHierarchyHighlighting();
this.sendContentIds();
});

// send `dv-clientStable` event when application is stable or loading of the content included finished
Expand Down Expand Up @@ -137,7 +146,6 @@ export class DesignViewService {
/**
* Workaround for the missing Firefox CSS support for :has to highlight
* only the last .design-view-wrapper in the .design-view-wrapper hierarchy.
*
*/
private applyHierarchyHighlighting() {
const designViewWrapper: NodeListOf<HTMLElement> = document.querySelectorAll('.design-view-wrapper');
Expand All @@ -148,4 +156,30 @@ export class DesignViewService {
}
});
}

/**
* Send IDs of the content artifacts (content includes, content pages, view contexts) to the Design View system.
*/
private sendContentIds() {
const contentIds: { id: string; resource: 'includes' | 'pages' | 'viewcontexts' }[] = [];
document.querySelectorAll('[includeid], [pageid], [viewcontextid]').forEach(element => {
// transfer only view contexts that have call parameters
if (element.getAttribute('viewcontextid')) {
const callParams = element.getAttribute('callparametersstring');
if (callParams) {
contentIds.push({
id: `${element.getAttribute('viewcontextid')}/entrypoint?${callParams}`,
resource: 'viewcontexts',
});
}
} else {
contentIds.push(
element.getAttribute('includeid')
? { id: element.getAttribute('includeid'), resource: 'includes' }
: { id: element.getAttribute('pageid'), resource: 'pages' }
);
}
});
this.messageToHost({ type: 'dv-clientContentIds', payload: { contentIds } });
}
}
7 changes: 6 additions & 1 deletion src/app/pages/content/content-page.component.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
<ng-container *ngIf="contentPage$ | async as contentPage">
<ish-content-pagelet *ngIf="contentPage.pageletIDs.length" [pageletId]="contentPage.pageletIDs[0]" />
<!-- the 'pageid' attribute is needed for the Design View and should not be removed -->
<ish-content-pagelet
*ngIf="contentPage.pageletIDs.length"
[pageletId]="contentPage.pageletIDs[0]"
[attr.pageid]="contentPage.id"
/>
</ng-container>

<ish-loading *ngIf="contentPageLoading$ | async" />
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ChangeDetectionStrategy, Component, Input, OnChanges } from '@angular/core';
import { ChangeDetectionStrategy, Component, ElementRef, Input, OnChanges } from '@angular/core';
import { Observable } from 'rxjs';

import { CMSFacade } from 'ish-core/facades/cms.facade';
Expand Down Expand Up @@ -34,9 +34,17 @@ export class ContentViewcontextComponent implements OnChanges {

viewContextEntrypoint$: Observable<ContentPageletEntryPointView>;

constructor(private cmsFacade: CMSFacade) {}
constructor(private cmsFacade: CMSFacade, private hostElement: ElementRef) {}

ngOnChanges() {
this.viewContextEntrypoint$ = this.cmsFacade.viewContext$(this.viewContextId, this.callParameters);

// the 'callparametersstring' attribute is needed for the Design View - do not remove this code
this.hostElement.nativeElement.setAttribute(
'callparametersstring',
Object.keys(this.callParameters)
.map(key => `${key}=${this.callParameters[key]}`)
.join('&')
);
}
}
Loading