ShellUI Logo
ShellUI

PrevNextNav

Previous/Next page navigation links — new in v0.3.0-alpha.2.

PrevNextNav is new in v0.3.0-alpha.2. It renders a pair of bordered navigation links for moving between doc pages. Perfect for adding at the bottom of any page.

Installation

shellui add prev-next-nav

Usage

Basic

<PrevNextNav
    PrevLabel="Installation"
    PrevHref="/docs/v0.3.0-alpha.2/installation"
    NextLabel="Components"
    NextHref="/docs/v0.3.0-alpha.2/components" />

Next only

Omit PrevHref to show only the Next link with an empty placeholder on the left:

<PrevNextNav
    NextLabel="Quick Start"
    NextHref="/docs/v0.3.0-alpha.2/quickstart" />

Prev only

<PrevNextNav
    PrevLabel="Quick Start"
    PrevHref="/docs/v0.3.0-alpha.2/quickstart" />

In a docs page layout

@* At the bottom of any .razor or .mdx page *@
<PrevNextNav
    PrevLabel="@prevPage.Title"
    PrevHref="@prevPage.Href"
    NextLabel="@nextPage.Title"
    NextHref="@nextPage.Href" />

API Reference

ParameterTypeDefaultDescription
PrevLabelstring?nullLabel for the previous link
PrevHrefstring?nullURL for the previous page. Omit to hide prev link.
NextLabelstring?nullLabel for the next link
NextHrefstring?nullURL for the next page. Omit to hide next link.
Classstring?nullAdditional CSS classes on the <nav> element

On this page