Skip to content

Commit d26cb74

Browse files
authored
docs(nav): component playground examples (#2498)
1 parent 4877710 commit d26cb74

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/api/nav.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,26 @@ Unlike Router Outlet, Nav is not tied to a particular router. This means that if
2727

2828
## Using NavLink
2929

30-
NavLink is a simplified API when interacting with Nav. Developers can customize the component, pass along component properties, modify the direction of the route animation or define a custom animation when navigating.
30+
NavLink is a simplified API when interacting with Nav. Developers can customize the component, pass along component properties, modify the direction of the route animation or define a custom animation when navigating.
3131

32-
import NavLinkExample from '@site/static/usage/v8/nav/nav-link/index.md';
32+
import NavLinkExample from '@site/static/usage/v8/nav/nav-link/index.md';
3333

3434
<NavLinkExample />
3535

36+
## Navigation within a Modal
37+
38+
Modal can use Nav to offer a linear navigation that is independent of the URL.
39+
40+
:::note
41+
42+
The example below uses a reference to Nav and the public method APIs to push and pop views. It is recommended to use NavLink in implementations that do not require this level of granular access and control.
43+
44+
:::
45+
46+
import ModalNavigationExample from '@site/static/usage/v8/nav/modal-navigation/index.md';
47+
48+
<ModalNavigationExample />
49+
3650
## Interfaces
3751

3852
### NavCustomEvent

0 commit comments

Comments
 (0)