From f54c409d26298fb72885fab2748474d43ff2052c Mon Sep 17 00:00:00 2001 From: Ryan Florence Date: Wed, 8 Jan 2025 16:05:26 -0700 Subject: [PATCH] api doc category rename/order --- packages/react-router/lib/components.tsx | 4 ++-- .../react-router/lib/dom-export/hydrated-router.tsx | 2 +- packages/react-router/lib/dom/lib.tsx | 10 +++++----- packages/react-router/lib/dom/server.tsx | 6 +++--- packages/react-router/typedoc.json | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/packages/react-router/lib/components.tsx b/packages/react-router/lib/components.tsx index 47c6aa2620..fb7dcb1e31 100644 --- a/packages/react-router/lib/components.tsx +++ b/packages/react-router/lib/components.tsx @@ -131,7 +131,7 @@ export function mapRouteProperties(route: RouteObject) { } /** - * @category Routers + * @category Data Routers */ export function createMemoryRouter( routes: RouteObject[], @@ -470,7 +470,7 @@ export interface MemoryRouterProps { /** * A `` that stores all entries in memory. * - * @category Router Components + * @category Component Routers */ export function MemoryRouter({ basename, diff --git a/packages/react-router/lib/dom-export/hydrated-router.tsx b/packages/react-router/lib/dom-export/hydrated-router.tsx index af8ae89b04..0bc1086868 100644 --- a/packages/react-router/lib/dom-export/hydrated-router.tsx +++ b/packages/react-router/lib/dom-export/hydrated-router.tsx @@ -199,7 +199,7 @@ function createHydratedRouter(): DataRouter { } /** - * @category Router Components + * @category Component Routers */ export function HydratedRouter() { if (!router) { diff --git a/packages/react-router/lib/dom/lib.tsx b/packages/react-router/lib/dom/lib.tsx index 413bd4527e..821b6a6457 100644 --- a/packages/react-router/lib/dom/lib.tsx +++ b/packages/react-router/lib/dom/lib.tsx @@ -135,7 +135,7 @@ interface DOMRouterOpts { } /** - * @category Routers + * @category Data Routers */ export function createBrowserRouter( routes: RouteObject[], @@ -155,7 +155,7 @@ export function createBrowserRouter( } /** - * @category Routers + * @category Data Routers */ export function createHashRouter( routes: RouteObject[], @@ -251,7 +251,7 @@ export interface BrowserRouterProps { /** * A `` for use in web browsers. Provides the cleanest URLs. * - * @category Router Components + * @category Component Routers */ export function BrowserRouter({ basename, @@ -301,7 +301,7 @@ export interface HashRouterProps { * A `` for use in web browsers. Stores the location in the hash * portion of the URL so it is not sent to the server. * - * @category Router Components + * @category Component Routers */ export function HashRouter({ basename, children, window }: HashRouterProps) { let historyRef = React.useRef(); @@ -350,7 +350,7 @@ export interface HistoryRouterProps { * version of the history library that React Router uses internally. * * @name unstable_HistoryRouter - * @category Router Components + * @category Component Routers */ export function HistoryRouter({ basename, diff --git a/packages/react-router/lib/dom/server.tsx b/packages/react-router/lib/dom/server.tsx index b5723c8cd6..4a0441b364 100644 --- a/packages/react-router/lib/dom/server.tsx +++ b/packages/react-router/lib/dom/server.tsx @@ -46,7 +46,7 @@ export interface StaticRouterProps { * A `` that may not navigate to any other location. This is useful * on the server where there is no stateful UI. * - * @category Router Components + * @category Component Routers */ export function StaticRouter({ basename, @@ -90,7 +90,7 @@ export interface StaticRouterProviderProps { * A Data Router that may not navigate to any other location. This is useful * on the server where there is no stateful UI. * - * @category Router Components + * @category Component Routers */ export function StaticRouterProvider({ context, @@ -268,7 +268,7 @@ export function createStaticHandler( } /** - * @category Routers + * @category Data Routers */ export function createStaticRouter( routes: RouteObject[], diff --git a/packages/react-router/typedoc.json b/packages/react-router/typedoc.json index d13d5cdaa8..0d1188a885 100644 --- a/packages/react-router/typedoc.json +++ b/packages/react-router/typedoc.json @@ -1,10 +1,10 @@ { "entryPoints": ["./index.ts"], "categoryOrder": [ - "Routers", - "Router Components", "Components", "Hooks", + "Data Routers", + "Component Routers", "Utils", "Types", "*"