Skip to content
Shortcode parameters
- toc_width_incontent
- Auto will adapt to the content, “100%” will result in a full width table of contents
Accepted values: 0 or 1 - toc_min_width
- Define a minimum width value to prevent the TOC from shrinking too much.
Accepted values: 0 or 1 - toc_max_width
- Maximum width of the table of contents.
Accepted values: 0 or 1 - hierarchy_offset
- Empty space per level of title depth. Set to “0” to have all the titles vertically inline.
Accepted values: numeric|unit (ex: “10|px”) - min_headings
- Table of contents will not be displayed if the number of headings of the current post is below this number
Accepted values: numeric - max_headings
- Table of contents will not be displayed if the number of headings of the current post is over this number
Accepted values: numeric - toc_is_sticky
- Makes the TOC sticky if placed in a sidebar widget
Accepted values: 0 or 1 - animate_on_fold
- Animates the TOC on fold/unfold
Accepted values: 0 or 1 - smooth_scroll
- Enables smooth scrolling when clicking an element of the table of contents
Accepted values: 0 or 1 - headings_full_row_clickable
- Lets the whole row including empty space and padding to be clickable, not only the text link
Accepted values: 0 or 1 - headings_overflow
- How to handle headings that are longer than the table of content (especially for mobile devices).
Accepted values: wrap, hidden-ellipsis, hidden - jump_to_offset
- Offset between the top of the viewport and the clicked heading.
Accepted values: numeric|unit (ex: “10|px”) - jump_to_offset_mobile
- Offset between the top of the viewport and the clicked heading (mobile).
Accepted values: numeric|unit (ex: “10|px”) - fold_on_load
- Keeps the table of contents folded upon page load
Accepted values: 0 or 1 - fold_if_headings_count
- Table of contents will not be folded upon page load if the number of headings exceed the specified amount.
Accepted values: 0 or 1 - hide_main_toc
- Hides the main TOC from the content while keeping the floating widget (activate to replicate the deprecated “Invisible, floating” mode)
Accepted values: 0 or 1 - show_header
- Show the table of contents header (title & toggle button)
Accepted values: 0 or 1 - toc_title
- Title of the Table of contents.
Accepted values: text - toc_title_alignment
- Alignement of the “Table of contents” title.
Accepted values: left, center, right - header_as_toggle
- A click anywhere on the header will toggle/collapse the toc
Accepted values: 0 or 1 - show_toggle
- Show the TOC toggle
Accepted values: 0 or 1 - toggle_position
- Position of the toggle button within the header.
Accepted values: left, right - toggle_type
- Type of toggle to be displayed.
Accepted values: icon (animated icon), icon-std (icon), text - toggle_button_icon
- Animated icons are icons made from CSS.
Accepted values: toggle-1, toggle-2 - toggle_button_text_closed
- This setting only applies to the Toggle type “Text” setting.
Accepted values: text - toggle_button_text_opened
- This setting only applies to the Toggle type “Text” setting.
Accepted values: text - toggle_button_icon_closed
- This setting only applies to the Toggle type “Icon” setting.
Accepted values: - toggle_button_icon_opened
- This setting only applies to the Toggle type “Icon” setting.
Accepted values: - numeration_type
- Numeration will be displayed before the heading.
Accepted values: none, numbers, roman, hexadecimal, binary - numeration_display
- Includes or not the parents numbers
Accepted values: single, full - numeration_separator
- Character that will separate numbers. Ex: “.” => “1.1.2”; “-” => “1-1-2”
Accepted values: text - numeration_suffix
- Character that will be shown after the numbers. Ex: “)” => “1.1.2)”; “/” => “1.1.2/”
Accepted values: text - columns_mode
- Enables multi-columns mode. Does not apply to floating widget.
Accepted values: 0 or 1 - columns_min_headings
- Will not switch to multi-columns node until the minimum number of headings has been reached.
Accepted values: numeric - columns_breakpoint
- Breakpoint (in px) after which the multi-columns mode gets activated. Do not add “px”.
Accepted values: numeric - headings_depth
- Select one or more items to specify what type of headings to pick up on for the table of contents
Accepted values: text of headings tags separated by a coma. (ex: “h2,h3”) - skip_h_by_text
- Headings to be excluded by custom text (one per line). Use * as wildcard to match any text. Ex: “m*rch” will exclude “march” and “merch”
Accepted values: text - skip_h_by_class
- Ignores headings with the specified css classes. For multiple classes, seperate by a blank space. ex: my-class1 my-class2
Accepted values: class names separated by a space - skip_h_by_ascending_class
- Ignores headings whose ancestor has the specified css class. For multiple classes, seperate by a blank space. ex: my-class1 my-class2
Accepted values: class names separated by a space - hash_format
- Handling of the anchor IDs. Existing IDs will not be changed. If heading cannot be processed, counter will come as a fallback
Accepted values: latin, all, all-translit, counter - hash_counter_prefix
- This setting only applies to the Hash format “Counter” setting.
Accepted values: text - activate_dynamic_unfold
- Dynamic unfold mode keeps the table of contents headings folded to the first level, and unfolds dynamically the current active heading. This mode is mostly suitable for a fixed toc in a sidebar or for the slide-out table of contents widget.
Accepted values: 0 or 1 - theme
- Description
Accepted values: slug of the theme (ex: “original-dark”) - toc_margin
- Description
Accepted values: - toc_padding
- Description
Accepted values: - toc_border_radius
- Description
Accepted values: - toc_border
- Description
Accepted values: - toc_border_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - toc_background_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - toc_shadow
- Description
Accepted values: 0 or 1 - toc_shadow_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - toc_header_height
- Description
Accepted values: 0 or 1 - toc_header_margin
- Description
Accepted values: 0 or 1 - toc_header_padding
- Description
Accepted values: 0 or 1 - toc_header_background_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - toc_title_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - toc_title_font_size
- Description
Accepted values: 0 or 1 - toc_title_font_weight
- Description
Accepted values: 0 or 1 - toc_toggle_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - toc_body_margin
- Description
Accepted values: 0 or 1 - toc_body_padding
- Description
Accepted values: 0 or 1 - toc_body_background_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_group_background_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_margin
- Description
Accepted values: 0 or 1 - headings_padding
- Description
Accepted values: 0 or 1 - headings_border_radius
- Description
Accepted values: 0 or 1 - headings_font_size
- Description
Accepted values: 0 or 1 - headings_height
- Description
Accepted values: 0 or 1 - headings_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_color_hover
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_color_active
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_line_height
- Description
Accepted values: 0 or 1 - headings_background_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_background_color_hover
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_background_color_active
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_link_margin
- Description
Accepted values: 0 or 1 - headings_link_padding
- Description
Accepted values: 0 or 1 - headings_link_font_size
- Description
Accepted values: 0 or 1 - headings_link_height
- Description
Accepted values: 0 or 1 - headings_link_color
- Description
Accepted values: 0 or 1 - headings_link_color_hover
- Description
Accepted values: 0 or 1 - headings_link_color_active
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_link_background_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_link_background_color_hover
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - headings_link_background_color_active
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - numeration_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - numeration_color_hover
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - numeration_color_active
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - activate_floating_table_of_contents
- Activates the floating TOC widget
Accepted values: 0 or 1 - floating_widget_height
- Floating widget height.
Accepted values: 0 or 1 - floating_hide_numeration
- Hides the numeration from the current heading in the floating widget
Accepted values: 0 or 1 - floating_nav_buttons
- Shows navigation buttons next to the active heading
Accepted values: 0 or 1 - floating_nav_buttons_position
- Navigation buttons position relative to the active heading
Accepted values: 0 or 1 - floating_nav_buttons_width
- Navigation buttons width
Accepted values: 0 or 1 - floating_compatibility_mode
- Activates the compatibility mode for the floating widget
Accepted values: 0 or 1 - floating_show_header
- Shows the header on the floating table of contents
Accepted values: 0 or 1 - expands_on
- Event that will expand the Table of contents. (hover event does not apply to mobile)
Accepted values: 0 or 1 - collapses_on
- Event that will collapse the Table of contents. (hover event does not apply to mobile)
Accepted values: 0 or 1 - floating_position
- Position of the fixed floating menu relative to the screen.
Accepted values: 0 or 1 - floating_offset_y
- Offset on the Y axis from the edge of the viewport (from top or bottom depending on the Floating position).
Accepted values: 0 or 1 - floating_offset_y_mobile
- If not set, the value will be the same as for Desktop
Accepted values: 0 or 1 - floating_offset_x
- Offset on the X axis from the edge of the container.
Accepted values: 0 or 1 - floating_widget_background_color
- Description
Accepted values: 0 or 1 - floating_widget_current_heading_padding
- Description
Accepted values: 0 or 1 - floating_widget_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - floating_widget_font_size
- Description
Accepted values: 0 or 1 - floating_widget_font_weight
- Description
Accepted values: 0 or 1 - floating_widget_nav_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - floating_toc_shadow
- Description
Accepted values: 0 or 1 - floating_toc_shadow_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - floating_widget_border_radius
- Description
Accepted values: 0 or 1 - activate_slide_out_table_of_contents
- Activates the slide-out table of contents
Accepted values: 0 or 1 - slide_out_auto_close
- Auto close the slide out upon clicking a heading on mobile
Accepted values: 0 or 1 - slide_out_open_on_load
- Have the slide-out TOC opened upon page load
Accepted values: 0 or 1 - slide_out_hide_header
- Hides the header and the TOC title from the Slide-out TOC
Accepted values: 0 or 1 - slide_out_width
- Width of the slide-out table of contents.
Accepted values: 0 or 1 - slide_out_mode
- Push content will push the content from the tag to the right or the left.
Accepted values: 0 or 1 - slide_out_position
- Position of the slide-out widget relative to the viewport
Accepted values: 0 or 1 - slide_out_toggle_position
- Position of the slide-out toggle button.
Accepted values: 0 or 1 - slide_out_toggle_width
- Width of the slide out toggle button
Accepted values: numeric|unit (ex: “10|px”) - slide_out_toggle_offset_y
- Offset from the top/bottom of the viewport.
Accepted values: 0 or 1 - slide_out_toggle_button_icon
- Description
Accepted values: 0 or 1 - slide_out_padding
- Padding of the slide-out area that contains the table of contents.
Accepted values: 0 or 1 - slide_out_background_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - slide_out_toggle_background_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - activate_progress_bar
- Shows a fixed progress bar that indicates the progression through the actual article contents
Accepted values: 0 or 1 - progress_bar_position
- Position of the progress bar
Accepted values: 0 or 1 - progress_bar_offset_y
- Offset from the top/bottom of the viewport.
Accepted values: 0 or 1 - progress_bar_offset_y_mobile
- Offset from the top/bottom of the viewport (mobile).
Accepted values: 0 or 1 - progress_bar_thickness
- Description
Accepted values: 0 or 1 - progress_bar_color
- Description
Accepted values: hexadecimal color code (ex: “#45FF28”) - progress_bar_background_color
