Skip to content

Commit

Permalink
docs(nav): component playground examples (#2498)
Browse files Browse the repository at this point in the history
  • Loading branch information
sean-perkins authored Oct 7, 2024
1 parent 4877710 commit d26cb74
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/api/nav.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,26 @@ Unlike Router Outlet, Nav is not tied to a particular router. This means that if

## Using NavLink

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.
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.

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

<NavLinkExample />

## Navigation within a Modal

Modal can use Nav to offer a linear navigation that is independent of the URL.

:::note

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.

:::

import ModalNavigationExample from '@site/static/usage/v8/nav/modal-navigation/index.md';

<ModalNavigationExample />

## Interfaces

### NavCustomEvent
Expand Down

0 comments on commit d26cb74

Please sign in to comment.