Skip to content
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.

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

[docs-infra] Add link to the source in API page if available #43387

Merged
merged 8 commits into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 15 additions & 2 deletions docs/src/modules/components/ApiPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ type ApiHeaderKeys =
| 'inheritance'
| 'slots'
| 'classes'
| 'css';
| 'css'
| 'source-code';

export function getTranslatedHeader(t: Translate, header: ApiHeaderKeys) {
const translations = {
Expand All @@ -59,6 +60,7 @@ export function getTranslatedHeader(t: Translate, header: ApiHeaderKeys) {
slots: t('api-docs.slots'),
classes: t('api-docs.classes'),
css: t('api-docs.css'),
'source-code': t('api-docs.source-code'),
};

// TODO Drop runtime type-checking once we type-check this file
Expand Down Expand Up @@ -202,7 +204,8 @@ export default function ApiPage(props: ApiPageProps) {
getPropertiesToC({ properties: propertiesDef, hash: 'props', t }),
...(componentSlots?.length > 0 ? [createTocEntry('slots')] : []),
...getClassesToC({ classes: classesDef, t }),
].filter(Boolean);
pageContent.filename ? createTocEntry('source-code') : null,
].filter((item): item is TableOfContentsParams => Boolean(item));

// The `ref` is forwarded to the root element.
let refHint = t('api-docs.refRootElement');
Expand Down Expand Up @@ -360,6 +363,16 @@ export default function ApiPage(props: ApiPageProps) {
layoutStorageKey={layoutStorageKey.classes}
displayClassKeys
/>

oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved
<Heading hash="source-code" level="h2" />
<p
dangerouslySetInnerHTML={{
__html: t('api-docs.seeSourceCode').replace(
'{{href}}',
`${process.env.SOURCE_CODE_REPO}/blob/v${process.env.LIB_VERSION}${pageContent.filename}`,
),
}}
/>
</MarkdownElement>
<svg style={{ display: 'none' }} xmlns="http://www.w3.org/2000/svg">
<symbol id="anchor-link-icon" viewBox="0 0 12 6">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export function ComponentLinkHeader(props: ComponentLinkHeaderProps) {
size="small"
variant="outlined"
rel="nofollow"
href={`${process.env.SOURCE_CODE_REPO}/tree/${process.env.SOURCE_GITHUB_BRANCH}/${headers.githubSource}`}
href={`${process.env.SOURCE_CODE_REPO}/blob/v${process.env.LIB_VERSION}/${headers.githubSource}`}
icon={<GitHubIcon />}
data-ga-event-category="ComponentLinkHeader"
data-ga-event-action="click"
Expand Down
2 changes: 2 additions & 0 deletions packages/mui-docs/src/translations/translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,15 @@
"refNotHeld": "The component cannot hold a ref.",
"refRootElement": "The <code>ref</code> is forwarded to the root element.",
"ruleName": "Rule name",
"seeSourceCode": "If you did not find the information in this page, consider having a look at the <a href=\"{{href}}\">implementation of the component</a> for more detail.",
"signature": "Signature",
"slots": "Slots",
"spreadHint": "Props of the {{spreadHintElement}} component are also available.",
"state": "STATE",
"styleOverrides": "The name <code>{{componentStyles.name}}</code> can be used when providing <a href={{defaultPropsLink}}>default props</a> or <a href={{styleOverridesLink}}>style overrides</a> in the theme.",
"slotDescription": "To learn how to customize the slot, check out the <a href={{slotGuideLink}}>Overriding component structure</a> guide.",
"slotName": "Slot name",
"source-code": "Source code",
"type": "Type",
"required": "Required",
"optional": "Optional",
Expand Down