[clang-doc] Make sidebar sections collapsible#174531
Merged
Conversation
Collapsible lists are achieved via `<details>` and their child `<summary>` tags. `<details>` tags allow for a section to be designated as collapsible, while the `<summary>` tag is used as the sidebar section's header. This approach was chosen over making the lists stateful through various CSS properties. This patch also refactors the `<li>` tag structure of sidebar sections. Previously, the section header and list items were in separate `<li>` tags without sharing a parent. Now, the header and items are under a single `<li>` tag which makes more sense semantically.
Member
|
@llvm/pr-subscribers-clang-tools-extra Author: Erick Velez (evelez7) ChangesCollapsible lists are achieved via This patch also refactors the Patch is 49.04 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/174531.diff 11 Files Affected:
diff --git a/clang-tools-extra/clang-doc/assets/clang-doc-mustache.css b/clang-tools-extra/clang-doc/assets/clang-doc-mustache.css
index 67f11f77eae61..0181e255f4d9f 100644
--- a/clang-tools-extra/clang-doc/assets/clang-doc-mustache.css
+++ b/clang-tools-extra/clang-doc/assets/clang-doc-mustache.css
@@ -421,8 +421,7 @@ body, html {
}
.sidebar ul li {
- padding-right: 1rem;
- padding-left: 2rem;
+ padding-left: 1rem;
padding-top: 0.25rem;
padding-bottom: 0.25rem;
}
@@ -430,8 +429,7 @@ body, html {
.sidebar-section {
font-size:1.5rem;
font-weight: bold;
- margin-bottom: 1rem;
- padding: 3rem;
+ padding-left: 1rem;
}
.sidebar-section a {
color: var(--brand)
diff --git a/clang-tools-extra/clang-doc/assets/class-template.mustache b/clang-tools-extra/clang-doc/assets/class-template.mustache
index 20510b6fd4d10..0b29ad23129c6 100644
--- a/clang-tools-extra/clang-doc/assets/class-template.mustache
+++ b/clang-tools-extra/clang-doc/assets/class-template.mustache
@@ -16,115 +16,131 @@
<h2>{{TagType}} {{Name}}</h2>
<ul>
{{#HasPublicMembers}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#PublicMembers">Public Members</a>
- </li>
<li>
- <ul>
- {{#PublicMembers}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
- </li>
- {{/PublicMembers}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#PublicMembers">Public Members</a>
+ </summary>
+ <ul>
+ {{#PublicMembers}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
+ </li>
+ {{/PublicMembers}}
+ </ul>
+ </details>
</li>
{{/HasPublicMembers}}
{{#ProtectedMembers}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#PublicMethods">Protected Members</a>
- </li>
<li>
- <ul>
- {{#Obj}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
- </li>
- {{/Obj}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#PublicMethods">Protected Members</a>
+ </summary>
+ <ul>
+ {{#Obj}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
+ </li>
+ {{/Obj}}
+ </ul>
+ </details>
</li>
{{/ProtectedMembers}}
{{#HasPublicFunctions}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#PublicMethods">Public Method</a>
- </li>
<li>
- <ul>
- {{#PublicFunctions}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/PublicFunctions}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#PublicMethods">Public Method</a>
+ </summary>
+ <ul>
+ {{#PublicFunctions}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
+ </li>
+ {{/PublicFunctions}}
+ </ul>
+ </details>
</li>
{{/HasPublicFunctions}}
{{#ProtectedFunction}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
- </li>
<li>
- <ul>
- {{#Obj}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
- </li>
- {{/Obj}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
+ </summary>
+ <ul>
+ {{#Obj}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
+ </li>
+ {{/Obj}}
+ </ul>
+ </details>
</li>
{{/ProtectedFunction}}
{{#HasEnums}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Enums">Enums</a>
- </li>
<li>
- <ul>
- {{#Enums}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/Enums}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Enums">Enums</a>
+ </summary>
+ <ul>
+ {{#Enums}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
+ </li>
+ {{/Enums}}
+ </ul>
+ </details>
</li>
{{/HasEnums}}
{{#HasTypedefs}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Typedefs">Typedefs</a>
- </li>
<li>
- <ul>
- {{#Typedefs}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/Typedefs}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Typedefs">Typedefs</a>
+ </summary>
+ <ul>
+ {{#Typedefs}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
+ </li>
+ {{/Typedefs}}
+ </ul>
+ </details>
</li>
{{/HasTypedefs}}
{{#HasRecords}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Classes">Inner Classes</a>
- </li>
<li>
- <ul>
- {{#Records}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/Records}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Classes">Inner Classes</a>
+ </summary>
+ <ul>
+ {{#Records}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
+ </li>
+ {{/Records}}
+ </ul>
+ </details>
</li>
{{/HasRecords}}
{{#HasFriends}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Friends">Friends</a>
- </li>
<li>
- <ul>
- {{#Friends}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{Reference.USR}}">{{Reference.Name}}</a>
- </li>
- {{/Friends}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Friends">Friends</a>
+ </summary>
+ <ul>
+ {{#Friends}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{Reference.USR}}">{{Reference.Name}}</a>
+ </li>
+ {{/Friends}}
+ </ul>
+ </details>
</li>
{{/HasRecords}}
</ul>
diff --git a/clang-tools-extra/clang-doc/assets/index-template.mustache b/clang-tools-extra/clang-doc/assets/index-template.mustache
index de64da4d709ee..cee7df872a0e8 100644
--- a/clang-tools-extra/clang-doc/assets/index-template.mustache
+++ b/clang-tools-extra/clang-doc/assets/index-template.mustache
@@ -8,17 +8,19 @@
<div class="sidebar">
<h2>{{ProjectName}}</h2>
<ul>
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Namespaces">Namespaces</a>
- </li>
<li>
- <ul>
- {{#Index}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
- </li>
- {{/Index}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Namespaces">Namespaces</a>
+ </summary>
+ <ul>
+ {{#Index}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
+ </li>
+ {{/Index}}
+ </ul>
+ </details>
</li>
</ul>
</div>
diff --git a/clang-tools-extra/clang-doc/assets/namespace-template.mustache b/clang-tools-extra/clang-doc/assets/namespace-template.mustache
index 2d8381a9ea6e3..567af626714ef 100644
--- a/clang-tools-extra/clang-doc/assets/namespace-template.mustache
+++ b/clang-tools-extra/clang-doc/assets/namespace-template.mustache
@@ -16,87 +16,99 @@
<h2>{{#RecordType}}{{RecordType}} {{/RecordType}}{{Name}}</h2>
<ul>
{{#HasEnums}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Enums">Enums</a>
- </li>
<li>
- <ul>
- {{#Enums}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/Enums}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Enums">Enums</a>
+ </summary>
+ <ul>
+ {{#Enums}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
+ </li>
+ {{/Enums}}
+ </ul>
+ </details>
</li>
{{/HasEnums}}
{{#HasRecords}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Classes">Inner Classes</a>
- </li>
<li>
- <ul>
- {{#Records}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/Records}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Classes">Inner Classes</a>
+ </summary>
+ <ul>
+ {{#Records}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
+ </li>
+ {{/Records}}
+ </ul>
+ </details>
</li>
{{/HasRecords}}
{{#HasFunctions}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Functions">Functions</a>
- </li>
<li>
- <ul>
- {{#Functions}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}{{#Template}}{{#Specialization}}<{{#Parameters}}{{Param}}{{^End}}, {{/End}}{{/Parameters}}>{{/Specialization}}{{/Template}}</a>
- </li>
- {{/Functions}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Functions">Functions</a>
+ </summary>
+ <ul>
+ {{#Functions}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}{{#Template}}{{#Specialization}}<{{#Parameters}}{{Param}}{{^End}}, {{/End}}{{/Parameters}}>{{/Specialization}}{{/Template}}</a>
+ </li>
+ {{/Functions}}
+ </ul>
+ </details>
</li>
{{/HasFunctions}}
{{#HasNamespaces}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Namespaces">Namespaces</a>
- </li>
<li>
- <ul>
- {{#Namespaces}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/Namespaces}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Namespaces">Namespaces</a>
+ </summary>
+ <ul>
+ {{#Namespaces}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
+ </li>
+ {{/Namespaces}}
+ </ul>
+ </details>
</li>
{{/HasNamespaces}}
{{#HasConcepts}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Concepts">Concepts</a>
- </li>
<li>
- <ul>
- {{#Concepts}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/Concepts}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ <a class="sidebar-item" href="#Concepts">Concepts</a>
+ </summary>
+ <ul>
+ {{#Concepts}}
+ <li class="sidebar-item-container">
+ <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
+ </li>
+ {{/Concepts}}
+ </ul>
+ </details>
</li>
{{/HasConcepts}}
{{#HasTypedefs}}
- <li class="sidebar-section">
- <a class="sidebar-item" href="#Typedefs">Typedefs</a>
- </li>
<li>
- <ul>
- {{#Typedefs}}
- <li class="sidebar-item-container">
- <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
- </li>
- {{/Typedefs}}
- </ul>
+ <details open>
+ <summary class="sidebar-section">
+ ...
[truncated]
|
Member
Author
ilovepi
approved these changes
Jan 6, 2026
Member
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Collapsible lists are achieved via
<details>and their child<summary>tags.<details>tags allow for a section to be designatedas collapsible, while the
<summary>tag is used as the sidebarsection's header. This approach was chosen over making the lists
stateful through various CSS properties.
This patch also refactors the
<li>tag structure of sidebar sections.Previously, the section header and list items were in separate
<li>tags without sharing a parent. Now, the header and items are under a
single
<li>tag which makes more sense semantically.