Contents Menu Expand Light mode Dark mode Auto light/dark mode
sphinx-basic-ng
sphinx-basic-ng
  • Goals
  • Expectations

Usage

  • Getting Started
  • Skeleton
  • Components
    • Breadcrumbs
    • “Edit this page” link
    • Ethical Ads
    • Site Logo
    • Related Pages
    • “Hide search matches” link
    • Search input
    • Sidebar Drawer Toggles
    • “View this page” link
  • Glossary

Project

  • Development
  • Design
  • Changelog
  • License
  • GitHub
Back to top

Sidebar Drawer Toggles#

This is a component that is highly coupled with the skeleton provided. The skeleton uses sidebar drawers, as part of providing a responsive skeleton for the themes. As a part of this, the pages need to include toggles so that users can show/hide the corresponding sidebars.

These components provide the user with the ability to include these drawers in an appropriate location on the page.

Usage#

{% include "components/toggle-sidebar-primary.html" %}
{% include "components/toggle-sidebar-secondary.html" %}

This will add a single label, which contains a hamburger svg by default. These labels are hidden with display: none when the corresponding sidebar is visible-by-default.

Configurability#

The theme author can change the inner contents of the label by overriding {% block content %}.

Next
“View this page” link
Previous
Search input
Copyright © 2023, Pradyun Gedam
Made with Sphinx and @pradyunsg's Furo
On this page
  • Sidebar Drawer Toggles
    • Usage
    • Configurability