@mui/docs 7.0.2 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Ad/Ad.js +1 -1
- package/CHANGELOG.md +97 -0
- package/NProgressBar/NProgressBar.js +2 -2
- package/esm/Ad/Ad.js +1 -1
- package/esm/NProgressBar/NProgressBar.js +1 -1
- package/esm/i18n/i18n.js +1 -1
- package/i18n/i18n.js +2 -2
- package/package.json +5 -5
- package/modern/Ad/Ad.d.ts +0 -6
- package/modern/Ad/AdCarbon.d.ts +0 -3
- package/modern/Ad/AdDisplay.d.ts +0 -16
- package/modern/Ad/AdGuest.d.ts +0 -10
- package/modern/Ad/AdInHouse.d.ts +0 -5
- package/modern/Ad/AdManager.d.ts +0 -19
- package/modern/Ad/AdProvider.d.ts +0 -15
- package/modern/Ad/ad.styles.d.ts +0 -4329
- package/modern/Ad/index.d.ts +0 -5
- package/modern/CodeCopy/CodeCopy.d.ts +0 -22
- package/modern/CodeCopy/CodeCopyButton.d.ts +0 -5
- package/modern/CodeCopy/index.d.ts +0 -3
- package/modern/CodeCopy/useClipboardCopy.d.ts +0 -4
- package/modern/ComponentLinkHeader/ComponentLinkHeader.d.ts +0 -9
- package/modern/ComponentLinkHeader/index.d.ts +0 -2
- package/modern/DocsProvider/DocsProvider.d.ts +0 -24
- package/modern/DocsProvider/index.d.ts +0 -1
- package/modern/HighlightedCode/HighlightedCode.d.ts +0 -14
- package/modern/HighlightedCode/index.d.ts +0 -1
- package/modern/HighlightedCodeWithTabs/HighlightedCodeWithTabs.d.ts +0 -29
- package/modern/HighlightedCodeWithTabs/index.d.ts +0 -2
- package/modern/InfoCard/InfoCard.d.ts +0 -22
- package/modern/InfoCard/index.d.ts +0 -1
- package/modern/Link/Link.d.ts +0 -25
- package/modern/Link/index.d.ts +0 -1
- package/modern/MarkdownElement/MarkdownElement.d.ts +0 -7
- package/modern/MarkdownElement/index.d.ts +0 -1
- package/modern/NProgressBar/NProgressBar.d.ts +0 -6
- package/modern/NProgressBar/index.d.ts +0 -2
- package/modern/SectionTitle/SectionTitle.d.ts +0 -7
- package/modern/SectionTitle/index.d.ts +0 -1
- package/modern/branding/BrandingProvider.d.ts +0 -9
- package/modern/branding/brandingTheme.d.ts +0 -147
- package/modern/branding/index.d.ts +0 -2
- package/modern/i18n/i18n.d.ts +0 -27
- package/modern/i18n/index.d.ts +0 -1
- package/modern/svgIcons/BundleSizeIcon.d.ts +0 -4
- package/modern/svgIcons/FigmaIcon.d.ts +0 -4
- package/modern/svgIcons/FileDownload.d.ts +0 -7
- package/modern/svgIcons/JavaScript.d.ts +0 -7
- package/modern/svgIcons/MaterialDesignIcon.d.ts +0 -4
- package/modern/svgIcons/SketchIcon.d.ts +0 -4
- package/modern/svgIcons/TypeScript.d.ts +0 -7
- package/modern/svgIcons/W3CIcon.d.ts +0 -4
- package/modern/translations/index.d.ts +0 -3
- package/modern/utils/loadScript.d.ts +0 -1
package/modern/Ad/index.d.ts
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
/**
|
|
3
|
-
* How to use: spread the handlers to the .MuiCode-root
|
|
4
|
-
*
|
|
5
|
-
* The html structure should be:
|
|
6
|
-
* <div className="MuiCode-root">
|
|
7
|
-
* <pre>...</pre>
|
|
8
|
-
* <button className="MuiCode-copy">...</button>
|
|
9
|
-
* </div>
|
|
10
|
-
*/
|
|
11
|
-
export declare function useCodeCopy(): React.HTMLAttributes<HTMLDivElement>;
|
|
12
|
-
interface CodeCopyProviderProps {
|
|
13
|
-
children: React.ReactNode;
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* Place <CodeCopyProvider> at the page level. It will check the keydown event and try to initiate copy click if rootNode exist.
|
|
17
|
-
* Any code block inside the tree can set the rootNode when mouse enter to leverage keyboard copy.
|
|
18
|
-
*/
|
|
19
|
-
export declare function CodeCopyProvider({
|
|
20
|
-
children
|
|
21
|
-
}: CodeCopyProviderProps): React.JSX.Element;
|
|
22
|
-
export {};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { MarkdownHeaders } from '@mui/internal-markdown';
|
|
3
|
-
export interface ComponentLinkHeaderProps {
|
|
4
|
-
design?: boolean;
|
|
5
|
-
markdown: {
|
|
6
|
-
headers: MarkdownHeaders;
|
|
7
|
-
};
|
|
8
|
-
}
|
|
9
|
-
export declare function ComponentLinkHeader(props: ComponentLinkHeaderProps): React.JSX.Element;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { Translations } from "../i18n/index.js";
|
|
3
|
-
import { AdConfig } from "../Ad/index.js";
|
|
4
|
-
export interface DocsConfig {
|
|
5
|
-
LANGUAGES: string[];
|
|
6
|
-
LANGUAGES_SSR: string[];
|
|
7
|
-
LANGUAGES_IN_PROGRESS: string[];
|
|
8
|
-
LANGUAGES_IGNORE_PAGES: (pathname: string) => boolean;
|
|
9
|
-
}
|
|
10
|
-
export interface DocsProviderProps {
|
|
11
|
-
config: DocsConfig;
|
|
12
|
-
adConfig?: Partial<AdConfig>;
|
|
13
|
-
defaultUserLanguage: string;
|
|
14
|
-
children?: React.ReactNode;
|
|
15
|
-
translations?: Translations;
|
|
16
|
-
}
|
|
17
|
-
export declare function DocsProvider({
|
|
18
|
-
config,
|
|
19
|
-
adConfig,
|
|
20
|
-
defaultUserLanguage,
|
|
21
|
-
translations,
|
|
22
|
-
children
|
|
23
|
-
}: DocsProviderProps): React.JSX.Element;
|
|
24
|
-
export declare function useDocsConfig(): DocsConfig;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./DocsProvider.js";
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { ButtonProps } from '@mui/material/Button';
|
|
3
|
-
import { SxProps } from '@mui/material/styles';
|
|
4
|
-
export interface HighlightedCodeProps {
|
|
5
|
-
code: string;
|
|
6
|
-
copyButtonHidden?: boolean;
|
|
7
|
-
copyButtonProps?: ButtonProps;
|
|
8
|
-
language: string;
|
|
9
|
-
parentComponent?: React.ElementType;
|
|
10
|
-
plainStyle?: boolean;
|
|
11
|
-
preComponent?: React.ElementType;
|
|
12
|
-
sx?: SxProps;
|
|
13
|
-
}
|
|
14
|
-
export declare const HighlightedCode: React.ForwardRefExoticComponent<HighlightedCodeProps & React.RefAttributes<HTMLDivElement>>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./HighlightedCode.js";
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
export declare const CodeTabList: import("@emotion/styled").StyledComponent<import("@mui/base/TabsList").TabsListOwnProps & Omit<any, keyof import("@mui/base/TabsList").TabsListOwnProps> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme> & {
|
|
3
|
-
ownerState: {
|
|
4
|
-
mounted: boolean;
|
|
5
|
-
contained?: boolean;
|
|
6
|
-
};
|
|
7
|
-
}, {}, {}>;
|
|
8
|
-
export declare const CodeTabPanel: import("@emotion/styled").StyledComponent<import("@mui/base/TabPanel").TabPanelOwnProps & Omit<any, keyof import("@mui/base/TabPanel").TabPanelOwnProps> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme> & {
|
|
9
|
-
ownerState: {
|
|
10
|
-
mounted: boolean;
|
|
11
|
-
contained?: boolean;
|
|
12
|
-
};
|
|
13
|
-
}, {}, {}>;
|
|
14
|
-
export declare const CodeTab: import("@emotion/styled").StyledComponent<import("@mui/base/Tab").TabOwnProps & Omit<any, keyof import("@mui/base/Tab").TabOwnProps> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme> & {
|
|
15
|
-
ownerState: {
|
|
16
|
-
mounted: boolean;
|
|
17
|
-
contained?: boolean;
|
|
18
|
-
};
|
|
19
|
-
}, {}, {}>;
|
|
20
|
-
type TabsConfig = {
|
|
21
|
-
code: string | ((tab: string) => string);
|
|
22
|
-
language: string;
|
|
23
|
-
tab: string;
|
|
24
|
-
};
|
|
25
|
-
export declare function HighlightedCodeWithTabs(props: {
|
|
26
|
-
tabs: Array<TabsConfig>;
|
|
27
|
-
storageKey?: string;
|
|
28
|
-
} & Record<string, any>): React.JSX.Element;
|
|
29
|
-
export {};
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { TypographyProps } from '@mui/material/Typography';
|
|
3
|
-
import { LinkProps } from "../Link/index.js";
|
|
4
|
-
interface GlowingIconContainerProps {
|
|
5
|
-
icon: React.ReactNode;
|
|
6
|
-
}
|
|
7
|
-
export declare function GlowingIconContainer({
|
|
8
|
-
icon
|
|
9
|
-
}: GlowingIconContainerProps): React.JSX.Element;
|
|
10
|
-
interface InfoCardProps {
|
|
11
|
-
classNameDescription?: string;
|
|
12
|
-
classNameTitle?: string;
|
|
13
|
-
description?: string;
|
|
14
|
-
icon?: React.ReactNode;
|
|
15
|
-
link?: string;
|
|
16
|
-
prefetch?: LinkProps['prefetch'];
|
|
17
|
-
svg?: React.ReactNode;
|
|
18
|
-
title: string;
|
|
19
|
-
titleProps?: TypographyProps;
|
|
20
|
-
}
|
|
21
|
-
export declare function InfoCard(props: InfoCardProps): React.JSX.Element;
|
|
22
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./InfoCard.js";
|
package/modern/Link/Link.d.ts
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { LinkProps as NextLinkProps } from 'next/link';
|
|
3
|
-
import { LinkProps as MuiLinkProps } from '@mui/material/Link';
|
|
4
|
-
/**
|
|
5
|
-
* File to keep in sync with:
|
|
6
|
-
*
|
|
7
|
-
* - /packages/mui-docs/src/Link/Link.tsx
|
|
8
|
-
* - /examples/material-ui-nextjs-pages-router/src/Link.js
|
|
9
|
-
* - /examples/material-ui-nextjs-pages-router-ts/src/Link.tsx
|
|
10
|
-
* - /examples/material-ui-nextjs-ts-v4-v5-migration/src/Link.tsx
|
|
11
|
-
*/
|
|
12
|
-
interface NextLinkComposedProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'>, Omit<NextLinkProps, 'href' | 'as' | 'passHref' | 'onMouseEnter' | 'onClick' | 'onTouchStart'> {
|
|
13
|
-
to: NextLinkProps['href'];
|
|
14
|
-
linkAs?: NextLinkProps['as'];
|
|
15
|
-
}
|
|
16
|
-
export declare const NextLinkComposed: React.ForwardRefExoticComponent<NextLinkComposedProps & React.RefAttributes<HTMLAnchorElement>>;
|
|
17
|
-
export type LinkProps = {
|
|
18
|
-
activeClassName?: string;
|
|
19
|
-
as?: NextLinkProps['as'];
|
|
20
|
-
href: NextLinkProps['href'];
|
|
21
|
-
linkAs?: NextLinkProps['as'];
|
|
22
|
-
noLinkStyle?: boolean;
|
|
23
|
-
} & Omit<NextLinkComposedProps, 'to' | 'linkAs' | 'href'> & Omit<MuiLinkProps, 'href'>;
|
|
24
|
-
export declare const Link: React.ForwardRefExoticComponent<Omit<LinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;
|
|
25
|
-
export {};
|
package/modern/Link/index.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./Link.js";
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
export interface MarkdownElementProps {
|
|
3
|
-
className?: string;
|
|
4
|
-
renderedMarkdown?: string;
|
|
5
|
-
children?: React.ReactNode;
|
|
6
|
-
}
|
|
7
|
-
export declare const MarkdownElement: React.ForwardRefExoticComponent<MarkdownElementProps & React.RefAttributes<HTMLDivElement>>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./MarkdownElement.js";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./SectionTitle.js";
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
export interface BrandingProviderProps {
|
|
3
|
-
children: React.ReactNode;
|
|
4
|
-
/**
|
|
5
|
-
* If not `undefined`, the provider is considered nesting and does not render NextNProgressBar & CssBaseline
|
|
6
|
-
*/
|
|
7
|
-
mode?: 'light' | 'dark';
|
|
8
|
-
}
|
|
9
|
-
export declare function BrandingProvider(props: BrandingProviderProps): React.JSX.Element;
|
|
@@ -1,147 +0,0 @@
|
|
|
1
|
-
import type { CSSObject } from '@mui/system';
|
|
2
|
-
import { ThemeOptions, Theme } from '@mui/material/styles';
|
|
3
|
-
interface ApplyDarkStyles {
|
|
4
|
-
(scheme: CSSObject): CSSObject;
|
|
5
|
-
}
|
|
6
|
-
declare module '@mui/material/styles' {
|
|
7
|
-
interface Theme {
|
|
8
|
-
applyDarkStyles: ApplyDarkStyles;
|
|
9
|
-
}
|
|
10
|
-
interface ColorRange {
|
|
11
|
-
50: string;
|
|
12
|
-
100: string;
|
|
13
|
-
200: string;
|
|
14
|
-
300: string;
|
|
15
|
-
400: string;
|
|
16
|
-
500: string;
|
|
17
|
-
600: string;
|
|
18
|
-
700: string;
|
|
19
|
-
800: string;
|
|
20
|
-
900: string;
|
|
21
|
-
}
|
|
22
|
-
interface PaletteColor extends ColorRange {}
|
|
23
|
-
interface Palette {
|
|
24
|
-
primaryDark: PaletteColor;
|
|
25
|
-
gradients: {
|
|
26
|
-
radioSubtle: string;
|
|
27
|
-
linearSubtle: string;
|
|
28
|
-
};
|
|
29
|
-
}
|
|
30
|
-
interface TypeText {
|
|
31
|
-
tertiary: string;
|
|
32
|
-
}
|
|
33
|
-
interface TypographyVariantsOptions {
|
|
34
|
-
fontWeightSemiBold?: number;
|
|
35
|
-
fontWeightExtraBold?: number;
|
|
36
|
-
fontFamilyCode?: string;
|
|
37
|
-
fontFamilySystem?: string;
|
|
38
|
-
}
|
|
39
|
-
interface TypographyVariants {
|
|
40
|
-
fontWeightSemiBold: number;
|
|
41
|
-
fontWeightExtraBold: number;
|
|
42
|
-
fontFamilyCode: string;
|
|
43
|
-
fontFamilySystem: string;
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
declare module '@mui/material/Chip' {
|
|
47
|
-
interface ChipPropsColorOverrides {
|
|
48
|
-
grey: true;
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
declare module '@mui/material/SvgIcon' {
|
|
52
|
-
interface SvgIconPropsColorOverrides {
|
|
53
|
-
danger: true;
|
|
54
|
-
}
|
|
55
|
-
interface SvgIconPropsSizeOverrides {
|
|
56
|
-
xs: true;
|
|
57
|
-
sm: true;
|
|
58
|
-
md: true;
|
|
59
|
-
lg: true;
|
|
60
|
-
xl: true;
|
|
61
|
-
xl2: true;
|
|
62
|
-
xl3: true;
|
|
63
|
-
xl4: true;
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
export declare const blue: {
|
|
67
|
-
50: string;
|
|
68
|
-
100: string;
|
|
69
|
-
200: string;
|
|
70
|
-
300: string;
|
|
71
|
-
400: string;
|
|
72
|
-
main: string;
|
|
73
|
-
500: string;
|
|
74
|
-
600: string;
|
|
75
|
-
700: string;
|
|
76
|
-
800: string;
|
|
77
|
-
900: string;
|
|
78
|
-
};
|
|
79
|
-
export declare const blueDark: {
|
|
80
|
-
50: string;
|
|
81
|
-
100: string;
|
|
82
|
-
200: string;
|
|
83
|
-
300: string;
|
|
84
|
-
main: string;
|
|
85
|
-
400: string;
|
|
86
|
-
500: string;
|
|
87
|
-
600: string;
|
|
88
|
-
700: string;
|
|
89
|
-
800: string;
|
|
90
|
-
900: string;
|
|
91
|
-
};
|
|
92
|
-
export declare const grey: {
|
|
93
|
-
50: string;
|
|
94
|
-
100: string;
|
|
95
|
-
200: string;
|
|
96
|
-
300: string;
|
|
97
|
-
400: string;
|
|
98
|
-
500: string;
|
|
99
|
-
600: string;
|
|
100
|
-
700: string;
|
|
101
|
-
800: string;
|
|
102
|
-
900: string;
|
|
103
|
-
};
|
|
104
|
-
export declare const error: {
|
|
105
|
-
50: string;
|
|
106
|
-
100: string;
|
|
107
|
-
200: string;
|
|
108
|
-
300: string;
|
|
109
|
-
400: string;
|
|
110
|
-
500: string;
|
|
111
|
-
main: string;
|
|
112
|
-
600: string;
|
|
113
|
-
700: string;
|
|
114
|
-
800: string;
|
|
115
|
-
900: string;
|
|
116
|
-
};
|
|
117
|
-
export declare const success: {
|
|
118
|
-
50: string;
|
|
119
|
-
100: string;
|
|
120
|
-
200: string;
|
|
121
|
-
300: string;
|
|
122
|
-
400: string;
|
|
123
|
-
500: string;
|
|
124
|
-
600: string;
|
|
125
|
-
700: string;
|
|
126
|
-
800: string;
|
|
127
|
-
900: string;
|
|
128
|
-
};
|
|
129
|
-
export declare const warning: {
|
|
130
|
-
50: string;
|
|
131
|
-
100: string;
|
|
132
|
-
200: string;
|
|
133
|
-
300: string;
|
|
134
|
-
400: string;
|
|
135
|
-
500: string;
|
|
136
|
-
main: string;
|
|
137
|
-
600: string;
|
|
138
|
-
700: string;
|
|
139
|
-
800: string;
|
|
140
|
-
900: string;
|
|
141
|
-
};
|
|
142
|
-
export declare const getMetaThemeColor: (mode: "light" | "dark") => string;
|
|
143
|
-
export declare const getDesignTokens: (mode: "light" | "dark") => ThemeOptions;
|
|
144
|
-
export declare function getThemedComponents(): ThemeOptions;
|
|
145
|
-
export declare const brandingDarkTheme: Theme;
|
|
146
|
-
export declare const brandingLightTheme: Theme;
|
|
147
|
-
export {};
|
package/modern/i18n/i18n.d.ts
DELETED
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import PropTypes from 'prop-types';
|
|
3
|
-
export interface UserLanguageProviderProps {
|
|
4
|
-
children: React.ReactNode;
|
|
5
|
-
translations?: Translations;
|
|
6
|
-
defaultUserLanguage: string;
|
|
7
|
-
}
|
|
8
|
-
export declare function UserLanguageProvider(props: UserLanguageProviderProps): React.JSX.Element;
|
|
9
|
-
export declare namespace UserLanguageProvider {
|
|
10
|
-
var propTypes: {
|
|
11
|
-
children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
|
|
12
|
-
defaultUserLanguage: PropTypes.Requireable<string>;
|
|
13
|
-
};
|
|
14
|
-
}
|
|
15
|
-
export declare function useUserLanguage(): string;
|
|
16
|
-
export declare function useSetUserLanguage(): React.Dispatch<React.SetStateAction<string>>;
|
|
17
|
-
export interface TranslateOptions {
|
|
18
|
-
ignoreWarning?: boolean;
|
|
19
|
-
}
|
|
20
|
-
export type Translate = (key: string, options?: TranslateOptions) => any;
|
|
21
|
-
export declare function useTranslate(): Translate;
|
|
22
|
-
export type Translations = { [key in string]?: string | Translations };
|
|
23
|
-
export interface RequireContext {
|
|
24
|
-
(req: string): string;
|
|
25
|
-
keys: () => string[];
|
|
26
|
-
}
|
|
27
|
-
export declare function mapTranslations(req: RequireContext): Translations;
|
package/modern/i18n/index.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./i18n.js";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export default function loadScript(src: string, position: HTMLElement): HTMLScriptElement;
|