Skip to content

Commit

Permalink
Merge pull request 18F#152 from arichiv-usds/sticky
Browse files Browse the repository at this point in the history
Add option for sticky subnav to pages
  • Loading branch information
Scott Weber authored Apr 5, 2018
2 parents 21fa897 + e14048f commit 55c37f5
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 4 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ redcarpet:
- with_toc_data
```

**Pro tip:** If you're like us and prefer your navigation sticky, you can add `sticky_sidenav: true` on [page](#layout-page), [project](#layout-project), and [team member](#layout-team-member) layouts to have the sidenav follow as you scroll.
### Color and font configuration
The default colors and fonts can be configured in the `_data/theme.yml` file.
Expand Down
2 changes: 1 addition & 1 deletion _layouts/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
---
{% assign sidenav = site.data.navigation[page.sidenav] | default: page.sidenav %}
{% if sidenav %}
<aside class="usa-layout-docs-sidenav sidenav">
<aside class="usa-layout-docs-sidenav sidenav {% if page.sticky_sidenav %}usa-sticky-sidenav{% endif %}">
{% include sidenav.html links=sidenav %}
</aside>

Expand Down
2 changes: 1 addition & 1 deletion _layouts/project.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
---


<aside class="usa-layout-docs-sidenav sidenav">
<aside class="usa-layout-docs-sidenav sidenav {% if page.sticky_sidenav %}usa-sticky-sidenav{% endif %}">
<ul class="usa-sidenav-list">
{% for item in site.projects %}
<li>
Expand Down
2 changes: 1 addition & 1 deletion _layouts/team-member.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
---


<aside class="usa-layout-docs-sidenav sidenav">
<aside class="usa-layout-docs-sidenav sidenav {% if page.sticky_sidenav %}usa-sticky-sidenav{% endif %}">
<ul class="usa-sidenav-list">
{% for item in site.team %}
<li>
Expand Down
5 changes: 5 additions & 0 deletions _sass/components/_side-nav.scss
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
.usa-sticky-sidenav {
position: sticky;
top: 1rem;
}

.usa-sidenav-list {
@if variable-exists(side-nav-bg) {
background-color: $side-nav-bg;
Expand Down
1 change: 0 additions & 1 deletion demo/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,3 @@ This is some more [content](https://18f.gsa.gov/).
###### Section six

This is some more [content](https://18f.gsa.gov/).

0 comments on commit 55c37f5

Please sign in to comment.