🔀Integration with routing libs
Like react-router or Next.js file system based route.
Depending on the framework or routing library you are using, links between pages are not handled the same way.
Usually, you'll have a <Link /> component provided by your routing library of choice. You need to let react-dsfr know about it so that whenever a link is needed in a DSFR component, you can provide the correct props for your <Link /> component.
When registering your Link component, its props type will propagate to the react-dsfr API.
Follow the setup described in the getting started section:
Usage Examples
Client side routing
import { Card } from "@codegouvfr/react-dsfr/Card";
<Card
linkProps={{
to: "/my-page"
}}
/>The <Link /> component from react-router will be used.
External links:
linkProps={{
href: "https://example.com"
target="_blank"
}}When react-dsfr detects that the href points to an external website it will use a regular <a/> instead of the <Link /> component.
Mailto links
linkProps={{
href: "mailto:[email protected]"
}}Same goes for the mailto links.
Converting a link to a button
linkProps={{
href: "#"
onClick: ()=> { /* ... */ }
}}React-dsfr will automatically convert the underlying HTML element into a <button /> that looks like a link for better Accessibility.
import type { AppProps } from "next/app";
import { fr } from "@codegouvfr/react-dsfr";
import { createNextDsfrIntegrationApi } from "@codegouvfr/react-dsfr/next-pagesdir";
import Link from "next/link";
// Only in TypeScript projects
declare module "@codegouvfr/react-dsfr/next-pagesdir" {
interface RegisterLink {
Link: typeof Link;
}
}
const {
withDsfr,
dsfrDocumentApi
} = createNextDsfrIntegrationApi({
defaultColorScheme: "system",
Link
});
export { dsfrDocumentApi };
function App({ Component, pageProps }: AppProps) {
return <Component {...pageProps} />;
}
export default withDsfr(App);Example here.
Examples
Client side routing
import { Card } from "@codegouvfr/react-dsfr/Card";
<Card
linkProps={{
href: "/my-page"
}}
/>The <Link /> component from react-router will be used.
External links:
linkProps={{
href: "https://example.com"
target="_blank"
}}When react-dsfr detects that the href points to an external website it will use a regular <a/> instead of the <Link /> component.
Mailto links
linkProps={{
to: "mailto:[email protected]"
}}Same goes for the mailto links.
Converting a link to a button
linkProps={{
to: "#"
onClick: ()=> { /* ... */ }
}}React-dsfr will automatically convert the underlying HTML element into a <button /> that looks like a link for better Accessibility.
Due to the fact that @tanstack/react-router is also implementing module augmentation it's just a tiny bit less straight forward to set up but it works great!
import React from "react";
import ReactDOM from "react-dom/client";
import { startReactDsfr } from "@codegouvfr/react-dsfr/spa";
import { Link, type LinkProps } from "@tanstack/react-router";
startReactDsfr({
defaultColorScheme: "system",
Link
});
declare module '@codegouvfr/react-dsfr/spa' {
interface RegisterLink {
Link: (props: LinkProps) => JSX.Element
}
}
ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
<React.StrictMode>
{/* ... */}
</React.StrictMode>
);After that you will have type safety on the linkProps, you can use the to property as you would on the react router's <Link /> component!
Note that if you want to link to external website (or use mailto:) you can use the href property instead of the to property (see below).
If you have a link that is a mailto: or a link to an external page, use the href property instead of to. Example:
<Header
navigation={[
{
text: "Contact",
linkProps: {
href: "mailto:[email protected]"
}
},
{
text: "Écrire au président"
linkProps: {
href: "https://www.elysee.fr/ecrire-au-president-de-la-republique/"
}
}
]}
/>type-route unlike most routing library doesn't export a <Link /> component, <a /> are used directly.
In consequence there isn't anything to setup.
Examples
Client side routing
import { Card } from "@codegouvfr/react-dsfr/Card";
import { routes } from "...";
<Card
linkProps={routes.myPage().link}
/>Example here.
If you are starting a new project you might want to use TanStack Router in place of react-router as it is, at least in my opignion a much better routing library.
import React from "react";
import ReactDOM from "react-dom/client";
import { startReactDsfr } from "@codegouvfr/react-dsfr/spa";
import { Link } from "react-router-dom";
startReactDsfr({
defaultColorScheme: "system",
Link
});
//Only in TypeScript projects
declare module "@codegouvfr/react-dsfr/spa" {
interface RegisterLink {
Link: typeof Link;
}
}
ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
<React.StrictMode>
{/* ... */}
</React.StrictMode>
);Everywhere a DSFR component accepts a xxxLinkProps you are expected to provide an object with a to property because react-router's<Link /> component expects a to prop instead of the typical href.
You can find an example here.
Examples
Client side routing
import { Card } from "@codegouvfr/react-dsfr/Card";
<Card
linkProps={{
to: "/my-page"
}}
/>The <Link /> component from react-router will be used.
External links:
linkProps={{
to: "https://example.com"
target="_blank"
}}When react-dsfr detects that the to points to an external website it will use a regular <a/> Instead of the <Link /> component.
Mailto links
linkProps={{
to: "mailto:[email protected]"
}}Same goes for the mailto links.
Converting a link to a button
linkProps={{
to: "#"
onClick: ()=> { /* ... */ }
}}React-dsfr will automatically convert the underlying HTML element into a <button /> that looks like a link for better Accessibility.
You should be able to infer what needs to be done refering to the react-router instructions.
If the library you are using doesn't export a <Link /> (like type-route for example) component, there isn't anything to do.
Last updated
Was this helpful?