3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-02 02:42:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add active link classes to site navigation menu (#463)

Browse source
This commit is contained in:
Elian Ibaj 2018-03-04 17:53:31 +01:00 • committed by Joel Marcey
parent 4ea8158c0c
commit 48ee457ec9
9 changed files with 66 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/guides-navigation.md
View file

@ -158,3 +158,15 @@ headerLinks: [
{ doc: 'bar', label: 'Bar' },
],
```
## Active Links In Site Navigation Bar
The links in the top navigation bar get `siteNavItemActive` and `siteNavGroupActive` class names to allow you to style the currently active link different from the others. `siteNavItemActive` is applied when there's an exact match between the navigation link and the currently displayed web page.
> This does not include links of type `href` which are meant for external links only. If you manually set an `href` in your headerLinks to an internal page, document, or blog post, it will not get the `siteNavItemActive` class even if that page is being displayed.
`siteNavGroupActive` will be added to these links:
* `doc` links that belong to the same sidebar as the currently displayed document
* The blog link when a blog post, or the blog listing page is being displayed
These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same css rule.