Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Docs Site] Add ComponentUsage component #23095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 18, 2025
Merged

[Docs Site] Add ComponentUsage component #23095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions src/components/ComponentUsage.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
import { z } from "astro:schema";
import { getComponentsUsage } from "~/util/components";
import Details from "./Details.astro";

type Props = z.infer<typeof props>;

const props = z.object({
component: z.string(),
});

const { component } = props.parse(Astro.props);

const usage = await getComponentsUsage(component);
---

<>
<p>
<code>{component}</code> is used <code>{usage.count}</code> times on{" "}
<code>{usage.pages.size}</code> pages.
</p>
<Details header={`Pages which use ${component}`}>
<ul>
{
[...usage.pages].map((path) => (
<li>
<a
href={
"https://github.com/cloudflare/cloudflare-docs/blob/production/" +
path
}
target="_blank"
>
{path}
</a>
</li>
))
}
</ul>
</Details>
</>
26 changes: 3 additions & 23 deletions src/components/ComponentsUsage.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
import { getComponentsUsage } from "~/util/components";
import AnchorHeading from "./AnchorHeading.astro";
import Details from "./Details.astro";
import ComponentUsage from "./ComponentUsage.astro";

const components = await getComponentsUsage();

Expand All @@ -11,30 +11,10 @@ const alphabetical = Object.entries(components).sort(([a], [b]) =>
---

{
alphabetical.map(([component, usage]) => (
alphabetical.map(([component]) => (
<>
<AnchorHeading depth={2} title={component} />
<p>
<code>{component}</code> is used <code>{usage.count}</code> times on{" "}
<code>{usage.pages.size}</code> pages.
</p>
<Details header={`Pages which use ${component}`}>
<ul>
{[...usage.pages].map((path) => (
<li>
<a
href={
"https://github.com/cloudflare/cloudflare-docs/blob/production/" +
path
}
target="_blank"
>
{path}
</a>
</li>
))}
</ul>
</Details>
<ComponentUsage component={component} />
</>
))
}
1 change: 1 addition & 0 deletions src/components/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export { default as APIRequest } from "./APIRequest.astro";
export { default as AvailableNotifications } from "./AvailableNotifications.astro";
export { default as CompatibilityFlag } from "./CompatibilityFlag.astro";
export { default as CompatibilityFlags } from "./CompatibilityFlags.astro";
export { default as ComponentUsage } from "./ComponentUsage.astro";
export { default as ComponentsUsage } from "./ComponentsUsage.astro";
export { default as CopyPageButton } from "./CopyPageButton.tsx";
export { default as CURL } from "./CURL.astro";
Expand Down
12 changes: 4 additions & 8 deletions src/components/overrides/PageTitle.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ import { marked } from "marked";
import { Breadcrumbs } from "astro-breadcrumbs";
import "astro-breadcrumbs/breadcrumbs.css";

import { Aside } from "@astrojs/starlight/components";
import Description from "~/components/Description.astro";
import SpotlightAuthorDetails from "~/components/SpotlightAuthorDetails.astro";
import LastReviewed from "~/components/LastReviewed.astro";
import CopyPageButton from "~/components/CopyPageButton.tsx";
import ComponentUsage from "~/components/ComponentUsage.astro";

import { getEntry } from "astro:content";

Expand Down Expand Up @@ -122,13 +122,9 @@ const hideBreadcrumbs = Astro.locals.starlightRoute.hideBreadcrumbs;

{
component && (
<Aside>
To see a list of pages this component is used on, please visit the{" "}
<a href={`/style-guide/components/usage/#${component.toLowerCase()}`}>
usage page
</a>
.
</Aside>
<div class="sl-markdown-content">
<ComponentUsage component={component} />
</div>
)
}

Expand Down
16 changes: 13 additions & 3 deletions src/util/components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@ import {
} from "mdast-util-mdx";
import { visit } from "unist-util-visit";

let usages: Record<string, { count: number; pages: Set<string> }>;
type Usage = { count: number; pages: Set<string> };

export const getComponentsUsage = async () => {
let usages: Record<string, Usage>;

export function getComponentsUsage(): Promise<Record<string, Usage>>;
export function getComponentsUsage(component: string): Promise<Usage>;
export async function getComponentsUsage(
component?: string,
): Promise<Usage | Record<string, Usage>> {
if (!usages) {
usages = {};

Expand Down Expand Up @@ -48,5 +54,9 @@ export const getComponentsUsage = async () => {
}
}

if (component) {
return usages[component] || { count: 0, pages: new Set() };
}

return usages;
};
}
Loading