File: sidebar-toggles.md

package info (click to toggle)
sphinx-basic-ng 1.0.0~beta2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 504 kB
  • sloc: python: 179; makefile: 5
file content (25 lines) | stat: -rw-r--r-- 848 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# 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

```jinja
{% 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 %}`.