Skip to content

View grouping in thumbnails sidebar #88

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.

Sign up for GitHub

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: main
Choose a base branch
from
Open

View grouping in thumbnails sidebar #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions src/css/structurizr-diagram.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@
border-style: none;
}

details.thumbnailGroup > summary:first-of-type {
display: list-item;
counter-increment: list-item 0;
list-style: inside disclosure-closed;
}
details.thumbnailGroup[open] > summary:first-of-type {
list-style-type: disclosure-open;
}

details.thumbnailGroup summary {
display: block;
unicode-bidi: isolate;
text-transform: capitalize;
}

.diagramThumbnail {
cursor: pointer;
margin: 0 0 40px 0;
Expand Down
76 changes: 53 additions & 23 deletions src/jsp/diagrams.jsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,33 +588,63 @@
function initThumbnails() {
var html = '';
var index = 1;
views.forEach(function(view) {
viewKeys.push(view.key);
var id = 'diagram' + index;
var title = structurizr.util.escapeHtml(structurizr.ui.getTitleForView(view));

html += '<div id="' + id + 'Thumbnail" class="diagramThumbnail centered small">';
// determine view group based on view property viewGroup if present
const viewGroups = views.reduce((acc, view) => {
const viewGroup = (view.properties?.viewGroup ?? 'default').toLowerCase();
if (!acc[viewGroup]) {
acc[viewGroup] = [];
}
acc[viewGroup].push(view);
return acc;
}, { default: []});

function _renderViews(views) {
views.forEach(function(view) {
viewKeys.push(view.key);
var id = 'diagram' + index;
var title = structurizr.util.escapeHtml(structurizr.ui.getTitleForView(view));

html += '<div id="' + id + 'Thumbnail" class="diagramThumbnail centered small">';

if (view.type === structurizr.constants.IMAGE_VIEW_TYPE) {
html += ' <img src="' + view.content + '" class="img-thumbnail viewThumbnail" style="margin-bottom: 10px;" /><br />';
} else {
<c:choose>
<c:when test="${not empty workspace.branch or not empty param.version or embed eq true}">
html += ' <img src="/static/img/thumbnail-not-available.png" class="img-thumbnail" style="margin-bottom: 10px" />';
</c:when>
<c:otherwise>
html += ' <img src="${thumbnailUrl}' + structurizr.util.escapeHtml(view.key) + '-thumbnail.png" class="img-thumbnail viewThumbnail" style="margin-bottom: 10px;" /><br />';
</c:otherwise>
</c:choose>
}

if (view.type === structurizr.constants.IMAGE_VIEW_TYPE) {
html += ' <img src="' + view.content + '" class="img-thumbnail viewThumbnail" style="margin-bottom: 10px;" /><br />';
} else {
<c:choose>
<c:when test="${not empty workspace.branch or not empty param.version or embed eq true}">
html += ' <img src="/static/img/thumbnail-not-available.png" class="img-thumbnail" style="margin-bottom: 10px" /></a>';
</c:when>
<c:otherwise>
html += ' <img src="${thumbnailUrl}' + structurizr.util.escapeHtml(view.key) + '-thumbnail.png" class="img-thumbnail viewThumbnail" style="margin-bottom: 10px;" /><br />';
</c:otherwise>
</c:choose>
}
html += '<div>';
html += title;
html += '<br /><span class="small">#' + structurizr.util.escapeHtml(view.key) + '</span>';
html += '</div></div>';

html += '<div>';
html += title;
html += '<br /><span class="small">#' + structurizr.util.escapeHtml(view.key) + '</span>';
html += '</div></div>';
index++;
});
}

index++;
});
// if only a single viewGroup is present, render the views directly
// this happends if no view has the custom property viewGroup set
if (Object.keys(viewGroups).length === 1) {
_renderViews(views);
} else {
Object.entries(viewGroups).forEach(([keyGroup, _views]) => {
html += '<details class="thumbnailGroup">';
html += '<summary>' + keyGroup + '</summary>';
html += '<div class="thumbnailGroupContent">';

_renderViews(_views);

html += '</div>';
html += '</details>';
})
}

$('#diagramNavigation').append(html);

Expand Down