Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(v2): allow activeBaseTest in NavLink #2690

Merged
merged 10 commits into from
May 17, 2020
Merged

feat(v2): allow activeBaseTest in NavLink #2690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
65cee89
Update documentation, add support for activeBaseTest
nebrelbug Apr 28, 2020
b3dc1de
Implicit else
nebrelbug Apr 28, 2020
4eac66e
Fix Regular Expression capitalization
nebrelbug Apr 28, 2020
15c5dbd
Refactor isActive to ternary function, rename activeBaseTest to activ…
nebrelbug Apr 28, 2020
ec179fd
Merge branch 'feat/navbar-active-base-path' of https://github.com/neb…
nebrelbug Apr 28, 2020
38c6b2a
Update website/docs/theme-classic.md
nebrelbug Apr 29, 2020
3c1bf39
Fix typo
nebrelbug Apr 29, 2020
3b6e598
Update website/docs/theme-classic.md
nebrelbug Apr 29, 2020
0752d9a
Update theme-classic.md
nebrelbug Apr 29, 2020
6839fa0
Merge branch 'master' into feat/navbar-active-base-path
lex111 May 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/docusaurus-theme-classic/src/theme/Navbar/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import styles from './styles.module.css';

function NavLink({
activeBasePath,
activeBaseRegex,
to,
href,
label,
Expand All @@ -45,10 +46,12 @@ function NavLink({
isNavLink: true,
activeClassName,
to: toUrl,
...(activeBasePath
...(activeBasePath || activeBaseRegex
? {
isActive: (_match, location) =>
location.pathname.startsWith(activeBaseUrl),
activeBaseRegex
? new RegExp(activeBaseRegex).test(location.pathname)
: location.pathname.startsWith(activeBaseUrl),
}
: null),
})}
Expand Down
5 changes: 5 additions & 0 deletions website/docs/theme-classic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,10 @@ module.exports = {
position: 'left', // or 'right'
// To apply the active class styling on all
// routes starting with this path.
// This usually isn't necessary
activeBasePath: 'docs',
// Alternative to activeBasePath if required.
activeBaseRegex: 'docs/(next|v8)',
// Custom CSS class (for styling any item).
className: '',
},
Expand All @@ -158,6 +161,8 @@ module.exports = {
};
```

React Router should automatically apply active link styling to links, but you can use `activeBasePath` in edge cases. For cases in which a link should be active on several different paths (such as when you have multiple doc folders under the same sidebar), you can use `activeBaseRegex`. `activeBaseRegex` is a more flexible alternative to `activeBasePath` and takes precedence over it -- Docusaurus parses it into a regular expression that is tested against the current URL.

Outbound (external) links automatically get `target="_blank" rel="noopener noreferrer"` attributes.

### Navbar Dropdown
Expand Down