Skip to content

Commit cecefd9

Browse files
committed
Clarify docstring
1 parent c6bcc1b commit cecefd9

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/components/nav/NavLink.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,10 @@ NavLink.propTypes = {
112112

113113
/**
114114
* Apply 'active' style to this component. Set to "exact" to automatically
115-
* toggle active status when pathname matches href, or to "partial" to
116-
* automatically toggle on a partial match.
115+
* toggle active status when the current pathname matches href, or to
116+
* "partial" to automatically toggle on a partial match. Assumes that href is
117+
* a relative url such as /link rather than an absolute such as
118+
* https://example.com/link
117119
*
118120
* For example
119121
* - dbc.NavLink(..., href="/my-page", active="exact") will be active on

0 commit comments

Comments
 (0)