Add opt-in collapsible option to TableOfContentsExtension - #259
Merged
Conversation
Wrap the generated table of contents in a <details>/<summary>
disclosure when collapsible is true, so a long contents list can
start collapsed and expand on click. Off by default: the output stays
the unchanged <nav class="toc">.
When enabled the heading list sits directly inside the disclosure:
<details class="toc">
<summary>Table of Contents</summary>
<ul> ... </ul>
</details>
The summary parameter sets the label (default "Table of Contents")
and open renders it expanded.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #259 +/- ##
=========================================
Coverage 92.37% 92.37%
- Complexity 3633 3635 +2
=========================================
Files 109 109
Lines 10277 10283 +6
=========================================
+ Hits 9493 9499 +6
Misses 784 784 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
What
Adds an opt-in
collapsibleoption toTableOfContentsExtensionthat wraps the generated table of contents in an HTML5<details>/<summary>disclosure, so a long contents list can start collapsed and expand on click.Mirrors markup-carve/carve-php#297 (the carve-php line), keeping the two library families consistent.
Behavior
collapsibleunset the output is the unchanged<nav class="toc">, so existing consumers are unaffected.<nav>):summary(defaultTable of Contents) sets the label and is HTML-escaped.openrenders it expanded; closed by default.Motivation
The wp-djot plugin currently produces a collapsible TOC via a plugin-level
preg_replacehack that rewrites the emitted<nav class="toc">into a<details>. This option lets the plugin drop that hack and use the library directly.Tests
4 new cases: collapsible closed/open, custom + escaped summary, and the unchanged non-collapsible path. TOC suite green; phpstan + phpcs clean on the touched files.