Overview

Page Link

Properties#

Exactly one of filepath, path, or uid is required — the rest are optional.

Prop Type Default Description
filepath string required (one of) Path to the destination MDX/MD file, relative to the project root. Resolved at build time.
path string required (one of) URL path of the destination page (e.g. /products/docs/components/row).
uid string required (one of) Stable page UID, resolved at build time. Useful when the URL or path may change.
title string 'Link to Page' Title shown in the link card.
description string 'Link to a page in the guide' Secondary text shown under the title.

Examples#

By Filepath#

Row Docs

<scalar-page-link
  filepath="documentation/guides/docs/components/row.mdx"
  title="Row Docs"
  description="Row component documentation">
</scalar-page-link>
<PageLink
  filepath="documentation/guides/docs/components/row.mdx"
  title="Row Docs"
  description="Row component documentation"
/>

By URL Path#

Row Docs

<scalar-page-link
  path="/products/docs/components/row"
  title="Row Docs"
  description="Linked by URL path">
</scalar-page-link>
<PageLink
  path="/products/docs/components/row"
  title="Row Docs"
  description="Linked by URL path"
/>

Title Only#

When only filepath (or path / uid) is provided, the default title and description are shown.

Row Docs

<scalar-page-link
  filepath="documentation/guides/docs/components/row.mdx"
  title="Row Docs">
</scalar-page-link>
<PageLink
  filepath="documentation/guides/docs/components/row.mdx"
  title="Row Docs"
/>

Updated

Was this page helpful?