Skip to content

Add support for "none" category #2664

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
Gerrit0 merged 2 commits into from
Aug 13, 2024
Merged

Add support for "none" category #2664

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce7b3b4
Add support for "none" category
nick-ls Aug 12, 2024
dfb19e6
Add support for "none" group
nick-ls Aug 12, 2024
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
18 changes: 16 additions & 2 deletions src/lib/output/themes/default/DefaultTheme.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,11 +383,11 @@ export class DefaultTheme extends Theme {
}

if (parent.categories && shouldShowCategories(parent, opts)) {
return filterMap(parent.categories, toNavigation);
return filterMapWithNoneCollection(parent.categories);
}

if (parent.groups && shouldShowGroups(parent, opts)) {
return filterMap(parent.groups, toNavigation);
return filterMapWithNoneCollection(parent.groups);
}

if (opts.includeFolders && parent.childrenIncludingDocuments?.some((child) => child.name.includes("/"))) {
Expand All @@ -397,6 +397,20 @@ export class DefaultTheme extends Theme {
return filterMap(parent.childrenIncludingDocuments, toNavigation);
}

function filterMapWithNoneCollection(reflection: ReflectionGroup[] | ReflectionCategory[]) {
const none = reflection.find((x) => x.title.toLocaleLowerCase() === "none");
const others = reflection.filter((x) => x.title.toLocaleLowerCase() !== "none");

const mappedOthers = filterMap(others, toNavigation);

if (none) {
const noneMappedChildren = filterMap(none.children, toNavigation);
return [...noneMappedChildren, ...mappedOthers];
}

return mappedOthers;
}

function deriveModuleFolders(children: Array<DeclarationReflection | DocumentReflection>) {
const result: NavigationElement[] = [];

Expand Down