Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs(cli): add LinkProvider example block (#3229)

Cindy Zhang8378b80f199a
diff --git a/.changeset/linkprovider-example-block.md b/.changeset/linkprovider-example-block.md
new file mode 100644
index 0000000000..c16d2f809b
--- /dev/null
+++ b/.changeset/linkprovider-example-block.md
@@ -0,0 +1,6 @@
+---
+'@astryxdesign/cli': patch
+---
+
+[docs] Add a LinkProvider example block showing how to swap in a framework router link (e.g. Next.js Link) for client-side routing (#2733)
+@cixzhang
diff --git a/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.doc.mjs b/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.doc.mjs
new file mode 100644
index 0000000000..5b60e25aa6
--- /dev/null
+++ b/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.doc.mjs
@@ -0,0 +1,14 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/** @type {import('../../../../../core/src/docs-types').TemplateDoc} */
+export const doc = {
+ type: 'block',
+ exampleFor: 'LinkProvider',
+ name: 'Link Provider — Custom Link Component',
+ displayName: 'Link Provider — Custom Link Component',
+ description:
+ 'Routes every Astryx link through a custom component that intercepts the click — the hook frameworks like Next.js use for client-side navigation. Click the link to see the custom handler fire instead of a full-page load.',
+ isReady: true,
+ aspectRatio: 4 / 3,
+ componentsUsed: ['LinkProvider', 'Link'],
+};
diff --git a/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.tsx b/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.tsx
new file mode 100644
index 0000000000..b8c8e058b7
--- /dev/null
+++ b/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.tsx
@@ -0,0 +1,43 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+'use client';
+
+import type {AnchorHTMLAttributes} from 'react';
+import {Link, LinkProvider} from '@astryxdesign/core/Link';
+
+/**
+ * A stand-in for a framework router link (e.g. Next.js `Link` or React
+ * Router `Link`). Instead of letting the browser do a full-page navigation,
+ * it intercepts the click and hands the destination to a custom handler —
+ * the same hook real routers use for client-side navigation. Here it just
+ * announces the target so the behavior swap is observable in the preview.
+ */
+function RouterLink({
+ href,
+ onClick,
+ children,
+ ...props
+}: AnchorHTMLAttributes<HTMLAnchorElement>) {
+ return (
+ <a
+ href={href}
+ onClick={e => {
+ e.preventDefault();
+ onClick?.(e);
+ alert(`RouterLink intercepted navigation to: ${href}`);
+ }}
+ {...props}>
+ {children}
+ </a>
+ );
+}
+
+export default function LinkProviderCustomLink() {
+ return (
+ <LinkProvider component={RouterLink}>
+ <Link href="/dashboard" isStandalone>
+ Go to dashboard
+ </Link>
+ </LinkProvider>
+ );
+}
diff --git a/packages/core/src/Link/LinkProvider.tsx b/packages/core/src/Link/LinkProvider.tsx
index 4675d65280..d295148e98 100644
--- a/packages/core/src/Link/LinkProvider.tsx
+++ b/packages/core/src/Link/LinkProvider.tsx
@@ -23,6 +23,7 @@
* - /packages/core/src/Link/index.ts
* - /packages/core/src/Link/Link.doc.mjs
* - /packages/cli/templates/blocks/components/Link/ (showcase blocks)
+ * - /packages/cli/templates/blocks/components/LinkProvider/ (example blocks)
*/
import {useMemo, type ReactNode} from 'react';