david smith

<p>Add a floating table of contents to your posts.  Style them as you see fit (to match your posts and branding).<br />
Acknowledgments—-<br />
Insparation and Code snippits from www.webdeasy.de<br />
FontAwesome Icons used under creative commons found here https://fontawesome.com/license</p>


Floating Table of Contents

Add a floating table of contents to your posts

LuckyWP

<p>Creates SEO-friendly table of contents for your posts, pages or custom post types. Great customizable appearance.</p>
<h4>Features</h4>
<ul>
<li>Automatical insertion a table of contents (configure post types and position).</li>
<li>SEO-friendly: table of contents code is ready to use by Google for snippets on result page.</li>
<li>Insert by shortcode, Gutenberg block or widget.</li>
<li>Button on toolbar of the classic editor.</li>
<li>Gutenberg block into “Common Blocks”.</li>
<li>Setting the minimum number of headings to display table of contents.</li>
<li>Setting the depth of headings for table of contents.</li>
<li>Skip headings by level or text.</li>
<li>Hierarchical or linear view.</li>
<li>Numeration items: decimal or roman numbers in order or nested.</li>
<li>Customizable appearance: width, float, title font size and weight, items font size, colors.</li>
<li>Color schemes (dark, light, white, transparent, inherit from theme) and the ability to override colors.</li>
<li>Toggle Show/Hide (optionally)</li>
<li>Customizable labels.</li>
<li>Smooth scroll (optionally).</li>
<li>Setting offset top for smooth scroll.</li>
<li>Wrap table of contents with <!–noindex–> tag (optionally).</li>
<li>Pretty hash in URL (like <code>example.com/faq/#how_do_this</code>).</li>
<li>RTL support.</li>
<li>Available override global settings for a particular post.</li>
<li>Highly compatible with WordPress themes and plugins.</li>
</ul>
<h4>Auto Insert</h4>
<p>For automatical insertion a table of contents in a posts, select option “Auto Insert Table of Contents” in the plugin settings (tab “Auto Insert”).</p>
<p>Supported positions:</p>
<ul>
<li>before first heading;</li>
<li>after first heading;</li>
<li>after first block (paragraph or heading);</li>
<li>top of post content;</li>
<li>bottom of post content.</li>
</ul>
<p>You can also select post types to which the table of contents will be automatically added.</p>
<h4>Manual Insert</h4>
<p>For manual insertion a table of content in a posts, use one of the ways:</p>
<ul>
<li>button “Table of Contents” on toolbar in classic editor;</li>
<li>gutenberg block “Table of Contents”;</li>
<li>shortcode <code>[lwptoc]</code>.</li>
</ul>
<h4>Pretty hash in URL</h4>
<p>By default, hash generated as heading text (for example, <code>#How_Do_This</code>). You can change hash format in global settings, tab “Misc.”.</p>
<p>For non-English websites it is recommended to enable the <code>Intl</code> PHP extension.</p>
<h3>Compatibility</h3>
<p>LuckyWP Table of Contents was successfully tested with the following plugins:</p>
<ul>
<li>Elementor Page Builder</li>
<li>Beaver Builder and Beaver Builder Themer Add-On</li>
<li>WPBakery Page Builder</li>
<li>Oxygen</li>
<li>WordPress Multilingual Plugin (WPML), <a href="https://wpml.org/plugin/luckywp-table-of-contents/" rel="nofollow ugc">officially confirmed</a></li>
<li>Rank Math, <a href="https://rankmath.com/compatibility/luckywp-table-of-contents/" rel="nofollow ugc">officially confirmed</a></li>
<li>WP Rocket</li>
<li>Toolset Views and Toolset Access</li>
</ul>
<h3>Hooks</h3>
<h4>Filters <code>lwptoc_before</code>, <code>lwptoc_after</code></h4>
<p>Use for add custom HTML before/after the table of contents.</p>
<p>Example:</p>
<pre><code>add_filter('lwptoc_before', function ($before) {
    return '<p>Example text before TOC.</p>' . $before;
});
</code></pre>
<h4>Filter <code>lwptoc_shortcode_tag</code></h4>
<p>Use this filter for change shortcode tag name <code>[lwptoc]</code>.</p>
<p>Example:</p>
<pre><code>add_filter('lwptoc_shortcode_tag', function ($tag) {
    return 'toc';
});
</code></pre>
<h4>Filter <code>lwptoc_heading_id</code></h4>
<p>Use for modify heading ID.</p>
<p>Example:</p>
<pre><code>add_filter('lwptoc_heading_id', function ($id, $label) {
    return $id;
}, 10, 2);
</code></pre>


LuckyWP Table of Contents

It does what one expects it to do and offers tons of useful options if one wants to tweak something. Simply great!

Really nice


Tried many ToC plugins, this one is great because it looks clean, and correctly handles the default state whether it's opened or closed!


Great plugin!

This is a great plugin! Initially, I wasn't sure about installing a plugin that automatically installs table of contents on every posts, instead of selected the posts I want to show the TOC on. After using it, I came to the conclusion that:
1/ It's much better if you may uninstall the plugin, it won't require removing code from posts;
2/ The options ensure you will make TOC available on posts that realy need it. It's very well thought.

Creates SEO-friendly table of contents for your posts/pages. Works automatically or manually (via shortcode, Gutenberg block or widget).

Floating Table of Contents vs LuckyWP Table of Contents