Skip to content

fix: toc grouping regression introduced by #10090 #10700

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

Merged
merged 2 commits into from
Jul 1, 2025
Merged

fix: toc grouping regression introduced by #10090 #10700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f75dba9
fix: toc grouping regression introduced by #10090
frarees Jun 4, 2025
3a6ca60
oversight
frarees Jun 9, 2025
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
12 changes: 11 additions & 1 deletion templates/default/toc.html.primary.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@ function transformMemberPage(model) {
"delegate": { key: "delegatesInSubtitle" },
};

var groupBy = [
"Constructor",
"Field",
"Property",
"Method",
"Event",
"Operator",
"Eii",
];

groupChildren(model);
transformItem(model, 1);
return model;
Expand All @@ -71,7 +81,7 @@ function transformMemberPage(model) {
var items = [];
item.items.forEach(function (element) {
groupChildren(element);
if (element.type) {
if (element.type && groupBy.includes(element.type)) {
var type = element.isEii ? "eii" : element.type.toLowerCase();
if (!grouped.hasOwnProperty(type)) {
if (!groupNames.hasOwnProperty(type)) {
Expand Down
33 changes: 21 additions & 12 deletions templates/default/toc.json.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ exports.transform = function (model) {
if (extension && extension.postTransform) {
model = extension.postTransform(model);
}

for (var key in model) {
if (key[0] === '_') {
delete model[key]
}
}

return {
content: JSON.stringify(model)
};
}

function transformMemberPage(model) {
var groupNames = {
"constructor": { key: "constructorsInSubtitle" },
Expand All @@ -43,11 +43,21 @@ exports.transform = function (model) {
"namespace": { key: "namespacesInSubtitle" },
"delegate": { key: "delegatesInSubtitle" },
};


var groupBy = [
"Constructor",
"Field",
"Property",
"Method",
"Event",
"Operator",
"Eii",
];

groupChildren(model);
transformItem(model, 1);
return model;

function groupChildren(item) {
if (!item || !item.items || item.items.length == 0) {
return;
Expand All @@ -56,7 +66,7 @@ exports.transform = function (model) {
var items = [];
item.items.forEach(function (element) {
groupChildren(element);
if (element.type) {
if (element.type && groupBy.includes(element.type)) {
var type = element.isEii ? "eii" : element.type.toLowerCase();
if (!grouped.hasOwnProperty(type)) {
if (!groupNames.hasOwnProperty(type)) {
Expand All @@ -72,7 +82,7 @@ exports.transform = function (model) {
items.push(element);
}
}, this);

// With order defined in groupNames
for (var key in groupNames) {
if (groupNames.hasOwnProperty(key) && grouped.hasOwnProperty(key)) {
Expand All @@ -82,18 +92,18 @@ exports.transform = function (model) {
})
}
}

item.items = items;
}

function transformItem(item, level) {
// set to null in case mustache looks up
item.topicHref = item.topicHref || null;
item.tocHref = item.tocHref || null;
item.name = item.name || null;

item.level = level;

if (item.items && item.items.length > 0) {
item.leaf = false;
var length = item.items.length;
Expand All @@ -106,4 +116,3 @@ exports.transform = function (model) {
}
}
}