Skip to content

Commit 3f2aff4

Browse files
authored
[material-ui][joy-ui] Remove warning from getInitColorSchemeScript (#42838)
1 parent a2972e8 commit 3f2aff4

File tree

3 files changed

+29
-45
lines changed

3 files changed

+29
-45
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
# fetch all tags which are required for `pnpm release:changelog`
3131
fetch-depth: 0
3232
- name: Set up pnpm
33-
uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
33+
uses: pnpm/action-setup@v4
3434
- name: Use Node.js 18.x
3535
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
3636
with:

packages/mui-joy/src/styles/CssVarsProvider.tsx

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { defaultConfig } from '../InitColorSchemeScript/InitColorSchemeScript';
1212
const {
1313
CssVarsProvider,
1414
useColorScheme,
15-
getInitColorSchemeScript: deprecatedGetInitColorSchemeScript,
15+
getInitColorSchemeScript: getInitColorSchemeScriptSystem,
1616
} = createCssVarsProvider<SupportedColorScheme, typeof THEME_ID>({
1717
themeId: THEME_ID,
1818
theme: defaultTheme,
@@ -25,22 +25,17 @@ const {
2525
},
2626
});
2727

28-
let warnedInitScriptOnce = false;
28+
/**
29+
* @deprecated use `InitColorSchemeScript` instead
30+
*
31+
* ```diff
32+
* - import { getInitColorSchemeScript } from '@mui/joy/styles';
33+
* + import InitColorSchemeScript from '@mui/joy/InitColorSchemeScript';
34+
*
35+
* - getInitColorSchemeScript();
36+
* + <InitColorSchemeScript />;
37+
* ```
38+
*/
39+
export const getInitColorSchemeScript = getInitColorSchemeScriptSystem;
2940

30-
const getInitColorSchemeScript: typeof deprecatedGetInitColorSchemeScript = (params) => {
31-
if (!warnedInitScriptOnce) {
32-
console.warn(
33-
[
34-
'MUI: The getInitColorSchemeScript function has been deprecated.',
35-
'',
36-
"You should use `import InitColorSchemeScript from '@mui/joy/InitColorSchemeScript'`",
37-
'and replace the function call with `<InitColorSchemeScript />` instead.',
38-
].join('\n'),
39-
);
40-
41-
warnedInitScriptOnce = true;
42-
}
43-
return deprecatedGetInitColorSchemeScript(params);
44-
};
45-
46-
export { CssVarsProvider, useColorScheme, getInitColorSchemeScript };
41+
export { CssVarsProvider, useColorScheme };

packages/mui-material/src/styles/CssVarsProvider.tsx

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const defaultTheme = experimental_extendTheme();
1919
const {
2020
CssVarsProvider,
2121
useColorScheme,
22-
getInitColorSchemeScript: deprecatedGetInitColorSchemeScript,
22+
getInitColorSchemeScript: getInitColorSchemeScriptSystem,
2323
} = createCssVarsProvider<SupportedColorScheme, typeof THEME_ID>({
2424
themeId: THEME_ID,
2525
theme: defaultTheme,
@@ -45,27 +45,16 @@ const {
4545
excludeVariablesFromRoot,
4646
});
4747

48-
let warnedInitScriptOnce = false;
49-
50-
// TODO: remove in v7
51-
const getInitColorSchemeScript: typeof deprecatedGetInitColorSchemeScript = (params) => {
52-
if (!warnedInitScriptOnce) {
53-
console.warn(
54-
[
55-
'MUI: The getInitColorSchemeScript function has been deprecated.',
56-
'',
57-
"You should use `import InitColorSchemeScript from '@mui/material/InitColorSchemeScript'`",
58-
'and replace the function call with `<InitColorSchemeScript />` instead.',
59-
].join('\n'),
60-
);
61-
62-
warnedInitScriptOnce = true;
63-
}
64-
return deprecatedGetInitColorSchemeScript(params);
65-
};
66-
67-
export {
68-
useColorScheme,
69-
getInitColorSchemeScript,
70-
CssVarsProvider as Experimental_CssVarsProvider,
71-
};
48+
/**
49+
* @deprecated Use `InitColorSchemeScript` instead
50+
* ```diff
51+
* - import { getInitColorSchemeScript } from '@mui/material/styles';
52+
* + import InitColorSchemeScript from '@mui/material/InitColorSchemeScript';
53+
*
54+
* - getInitColorSchemeScript();
55+
* + <InitColorSchemeScript />;
56+
* ```
57+
*/
58+
export const getInitColorSchemeScript = getInitColorSchemeScriptSystem;
59+
60+
export { useColorScheme, CssVarsProvider as Experimental_CssVarsProvider };

0 commit comments

Comments
 (0)