Skip to content

Commit b0028db

Browse files
authored
[docs-infra] Improve Typedocs HTML Weight (#4497)
1 parent ebf39a2 commit b0028db

6 files changed

Lines changed: 65 additions & 28 deletions

File tree

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"@base-ui/utils": "workspace:*",
2121
"@mdx-js/loader": "^3.1.1",
2222
"@mdx-js/react": "^3.1.1",
23-
"@mui/internal-docs-infra": "0.7.1-canary.0",
23+
"@mui/internal-docs-infra": "0.8.1-canary.0",
2424
"@next/mdx": "^16.1.6",
2525
"@react-spring/web": "^10.0.3",
2626
"@stefanprobst/rehype-extract-toc": "^3.0.0",

docs/src/code-components.tsx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
'use client';
2+
3+
import * as React from 'react';
4+
import { CodeComponentsContext } from '@mui/internal-docs-infra/useCode';
5+
import type { MDXComponents } from 'mdx/types';
6+
import { Link } from './components/Link';
7+
import { TypeRef } from './components/TypeRef';
8+
import { TypePropRef } from './components/TypePropRef';
9+
10+
export const codeComponents: MDXComponents = {
11+
a: Link,
12+
TypeRef,
13+
TypePropRef,
14+
};
15+
16+
export function CodeComponentsProvider({ children }: { children: React.ReactNode }) {
17+
return (
18+
<CodeComponentsContext.Provider value={codeComponents}>
19+
{children}
20+
</CodeComponentsContext.Provider>
21+
);
22+
}

docs/src/components/DocsProviders.tsx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,18 @@ import * as React from 'react';
22
import { Tooltip } from '@base-ui/react/tooltip';
33
import { TypesDataProvider } from '@mui/internal-docs-infra/useType';
44
import { PackageManagerSnippetProvider } from 'docs/src/blocks/PackageManagerSnippet/PackageManagerSnippetProvider';
5+
import { CodeComponentsProvider } from 'docs/src/code-components';
56

67
export function DocsProviders({ children }: { children: React.ReactNode }) {
78
return (
89
<Tooltip.Provider delay={350}>
9-
<TypesDataProvider>
10-
<PackageManagerSnippetProvider defaultValue="npm">{children}</PackageManagerSnippetProvider>
11-
</TypesDataProvider>
10+
<CodeComponentsProvider>
11+
<TypesDataProvider>
12+
<PackageManagerSnippetProvider defaultValue="npm">
13+
{children}
14+
</PackageManagerSnippetProvider>
15+
</TypesDataProvider>
16+
</CodeComponentsProvider>
1217
</Tooltip.Provider>
1318
);
1419
}

docs/src/components/ReferenceTable/PropertiesReferenceAccordion.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import * as React from 'react';
22
import { visuallyHidden } from '@base-ui/utils/visuallyHidden';
33
import type { EnhancedProperty } from '@mui/internal-docs-infra/useTypes';
4+
import { stringOrHastToString } from '@mui/internal-docs-infra/pipeline/hastUtils';
45
import { Link } from 'docs/src/components/Link';
56
import * as Accordion from '../Accordion';
67
import * as DescriptionList from '../DescriptionList';
@@ -42,7 +43,9 @@ export function PropertiesReferenceAccordion({ data, name: partName, ...props }:
4243
// anchor hash for each property
4344
const id = `${partName}-${name}`;
4445

45-
const shortTypeText = prop.shortTypeText ?? 'type';
46+
const shortTypeText = prop.shortType
47+
? stringOrHastToString(prop.shortType as string)
48+
: 'type';
4649

4750
// Build modifiers string
4851
const modifiers: string[] = [];

docs/src/components/ReferenceTable/ReferenceAccordion.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import * as React from 'react';
22
import { visuallyHidden } from '@base-ui/utils/visuallyHidden';
33
import type { EnhancedProperty } from '@mui/internal-docs-infra/useTypes';
4+
import { stringOrHastToString } from '@mui/internal-docs-infra/pipeline/hastUtils';
45
import { Link } from 'docs/src/components/Link';
56
import * as Accordion from '../Accordion';
67
import * as CodeBlock from '../CodeBlock';
@@ -63,7 +64,9 @@ export function ReferenceAccordion({
6364
// anchor hash for each prop
6465
const id = `${partName.replace('.', '')}-${name}`;
6566

66-
const shortTypeText = prop.shortTypeText ?? 'type';
67+
const shortTypeText = prop.shortType
68+
? stringOrHastToString(prop.shortType as string)
69+
: 'type';
6770
const defaultText = prop.defaultText;
6871

6972
return (

pnpm-lock.yaml

Lines changed: 26 additions & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)