@backstage/plugin-mui-to-bui 0.2.2 → 0.2.3
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/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @backstage/plugin-mui-to-bui
|
|
2
2
|
|
|
3
|
+
## 0.2.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- f157f43: Fix installation command
|
|
8
|
+
- e4a1180: Updated tokens from `--bui-bg` to `--bui-bg-surface-0`
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
- @backstage/ui@0.11.0
|
|
11
|
+
- @backstage/frontend-plugin-api@0.13.3
|
|
12
|
+
|
|
13
|
+
## 0.2.3-next.0
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- e4a1180: Updated tokens from `--bui-bg` to `--bui-bg-surface-0`
|
|
18
|
+
- Updated dependencies
|
|
19
|
+
- @backstage/ui@0.11.0-next.0
|
|
20
|
+
- @backstage/core-plugin-api@1.12.1
|
|
21
|
+
- @backstage/frontend-plugin-api@0.13.2
|
|
22
|
+
- @backstage/theme@0.7.1
|
|
23
|
+
|
|
3
24
|
## 0.2.2
|
|
4
25
|
|
|
5
26
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ The Backstage UI Themer helps you convert an existing MUI v5 theme into Backstag
|
|
|
11
11
|
Run this from your Backstage repo root:
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
yarn
|
|
14
|
+
yarn --cwd packages/app add @backstage/plugin-mui-to-bui
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
### 2) Wire it up depending on your frontend system
|
|
@@ -55,9 +55,10 @@ function generateBuiVariables(theme) {
|
|
|
55
55
|
styleObject[`--bui-fg-${key}`] = value;
|
|
56
56
|
});
|
|
57
57
|
Object.entries({
|
|
58
|
-
"": palette.background.default,
|
|
58
|
+
"surface-0": palette.background.default,
|
|
59
59
|
"surface-1": palette.background.paper,
|
|
60
60
|
"surface-2": palette.background.default,
|
|
61
|
+
"surface-3": palette.background.default,
|
|
61
62
|
solid: palette.primary.main,
|
|
62
63
|
"solid-hover": blend(palette.primary.main, palette.primary.dark, 0.5),
|
|
63
64
|
"solid-pressed": palette.primary.dark,
|
|
@@ -70,7 +71,7 @@ function generateBuiVariables(theme) {
|
|
|
70
71
|
warning: palette.warning.light,
|
|
71
72
|
success: palette.success.light
|
|
72
73
|
}).forEach(([key, value]) => {
|
|
73
|
-
styleObject[`--bui-bg
|
|
74
|
+
styleObject[`--bui-bg-${key}`] = value;
|
|
74
75
|
});
|
|
75
76
|
Object.entries({
|
|
76
77
|
danger: palette.error.main,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"convertMuiToBuiTheme.esm.js","sources":["../../../src/components/BuiThemerPage/convertMuiToBuiTheme.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Theme as Mui5Theme } from '@mui/material/styles';\nimport { BackstagePaletteAdditions } from '@backstage/theme';\nimport { blend, alpha } from '@mui/system/colorManipulator';\n\nexport interface ConvertMuiToBuiThemeResult {\n css: string;\n styleObject: Record<string, string>;\n}\n\n/**\n * Converts a MUI v5 Theme to BUI CSS variables\n * @param theme - The MUI v5 theme to convert\n * @returns Object containing CSS string and style object with BUI variables\n */\nexport function convertMuiToBuiTheme(\n theme: Mui5Theme,\n): ConvertMuiToBuiThemeResult {\n const styleObject = generateBuiVariables(theme);\n\n const selector =\n theme.palette.mode === 'dark' ? \"[data-theme-mode='dark']\" : ':root';\n\n const css = `${selector} {\\n${Object.entries(styleObject)\n .map(([key, value]) => ` ${key}: ${value};`)\n .join('\\n')}\\n}`;\n\n return { css, styleObject };\n}\n\n/**\n * Generates BUI CSS variables from MUI theme\n */\nfunction generateBuiVariables(theme: Mui5Theme): Record<string, string> {\n const styleObject: Record<string, string> = {};\n\n // Font families\n if (theme.typography.fontFamily) {\n styleObject['--bui-font-regular'] = theme.typography.fontFamily;\n }\n\n // Font weights\n if (theme.typography.fontWeightRegular) {\n styleObject['--bui-font-weight-regular'] = String(\n theme.typography.fontWeightRegular,\n );\n }\n if (theme.typography.fontWeightBold) {\n styleObject['--bui-font-weight-bold'] = String(\n theme.typography.fontWeightBold,\n );\n }\n\n const spacing = theme.spacing(1);\n // Skip spacing if the theme is using the default\n if (spacing !== '8px') {\n styleObject['--bui-space'] = `calc(${spacing} * 0.5)`;\n }\n\n // Border radius, only translate a 0 radius\n if (theme.shape.borderRadius === 0) {\n styleObject['--bui-radius-1'] = '0';\n styleObject['--bui-radius-2'] = '0';\n styleObject['--bui-radius-3'] = '0';\n styleObject['--bui-radius-4'] = '0';\n styleObject['--bui-radius-5'] = '0';\n styleObject['--bui-radius-6'] = '0';\n }\n\n // Colors - map MUI palette to BUI color tokens\n const palette = theme.palette as typeof theme.palette &\n Partial<BackstagePaletteAdditions>;\n\n // Base colors\n styleObject['--bui-black'] = palette.common.black;\n styleObject['--bui-white'] = palette.common.white;\n\n // Generate foreground colors\n Object.entries({\n primary: palette.text.primary,\n secondary: palette.textSubtle,\n link: palette.link ?? palette.primary.main,\n 'link-hover': palette.linkHover ?? palette.primary.dark,\n disabled: palette.text.disabled,\n solid: palette.primary.contrastText,\n 'solid-disabled': palette.text.disabled,\n tint: palette.textSubtle,\n 'tint-disabled': palette.textVerySubtle,\n danger: palette.error.dark,\n warning: palette.warning.dark,\n success: palette.success.dark,\n }).forEach(([key, value]) => {\n styleObject[`--bui-fg-${key}`] = value;\n });\n\n // Generate surface colors\n Object.entries({\n '': palette.background.default,\n 'surface-1': palette.background.paper,\n 'surface-2': palette.background.default,\n solid: palette.primary.main,\n 'solid-hover': blend(palette.primary.main, palette.primary.dark, 0.5),\n 'solid-pressed': palette.primary.dark,\n 'solid-disabled': palette.action.disabledBackground,\n tint: 'transparent',\n 'tint-hover': alpha(palette.primary.main, 0.4),\n 'tint-pressed': alpha(palette.primary.main, 0.6),\n 'tint-disabled': palette.action.disabledBackground,\n danger: palette.error.light,\n warning: palette.warning.light,\n success: palette.success.light,\n }).forEach(([key, value]) => {\n styleObject[`--bui-bg
|
|
1
|
+
{"version":3,"file":"convertMuiToBuiTheme.esm.js","sources":["../../../src/components/BuiThemerPage/convertMuiToBuiTheme.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Theme as Mui5Theme } from '@mui/material/styles';\nimport { BackstagePaletteAdditions } from '@backstage/theme';\nimport { blend, alpha } from '@mui/system/colorManipulator';\n\nexport interface ConvertMuiToBuiThemeResult {\n css: string;\n styleObject: Record<string, string>;\n}\n\n/**\n * Converts a MUI v5 Theme to BUI CSS variables\n * @param theme - The MUI v5 theme to convert\n * @returns Object containing CSS string and style object with BUI variables\n */\nexport function convertMuiToBuiTheme(\n theme: Mui5Theme,\n): ConvertMuiToBuiThemeResult {\n const styleObject = generateBuiVariables(theme);\n\n const selector =\n theme.palette.mode === 'dark' ? \"[data-theme-mode='dark']\" : ':root';\n\n const css = `${selector} {\\n${Object.entries(styleObject)\n .map(([key, value]) => ` ${key}: ${value};`)\n .join('\\n')}\\n}`;\n\n return { css, styleObject };\n}\n\n/**\n * Generates BUI CSS variables from MUI theme\n */\nfunction generateBuiVariables(theme: Mui5Theme): Record<string, string> {\n const styleObject: Record<string, string> = {};\n\n // Font families\n if (theme.typography.fontFamily) {\n styleObject['--bui-font-regular'] = theme.typography.fontFamily;\n }\n\n // Font weights\n if (theme.typography.fontWeightRegular) {\n styleObject['--bui-font-weight-regular'] = String(\n theme.typography.fontWeightRegular,\n );\n }\n if (theme.typography.fontWeightBold) {\n styleObject['--bui-font-weight-bold'] = String(\n theme.typography.fontWeightBold,\n );\n }\n\n const spacing = theme.spacing(1);\n // Skip spacing if the theme is using the default\n if (spacing !== '8px') {\n styleObject['--bui-space'] = `calc(${spacing} * 0.5)`;\n }\n\n // Border radius, only translate a 0 radius\n if (theme.shape.borderRadius === 0) {\n styleObject['--bui-radius-1'] = '0';\n styleObject['--bui-radius-2'] = '0';\n styleObject['--bui-radius-3'] = '0';\n styleObject['--bui-radius-4'] = '0';\n styleObject['--bui-radius-5'] = '0';\n styleObject['--bui-radius-6'] = '0';\n }\n\n // Colors - map MUI palette to BUI color tokens\n const palette = theme.palette as typeof theme.palette &\n Partial<BackstagePaletteAdditions>;\n\n // Base colors\n styleObject['--bui-black'] = palette.common.black;\n styleObject['--bui-white'] = palette.common.white;\n\n // Generate foreground colors\n Object.entries({\n primary: palette.text.primary,\n secondary: palette.textSubtle,\n link: palette.link ?? palette.primary.main,\n 'link-hover': palette.linkHover ?? palette.primary.dark,\n disabled: palette.text.disabled,\n solid: palette.primary.contrastText,\n 'solid-disabled': palette.text.disabled,\n tint: palette.textSubtle,\n 'tint-disabled': palette.textVerySubtle,\n danger: palette.error.dark,\n warning: palette.warning.dark,\n success: palette.success.dark,\n }).forEach(([key, value]) => {\n styleObject[`--bui-fg-${key}`] = value;\n });\n\n // Generate surface colors\n Object.entries({\n 'surface-0': palette.background.default,\n 'surface-1': palette.background.paper,\n 'surface-2': palette.background.default,\n 'surface-3': palette.background.default,\n solid: palette.primary.main,\n 'solid-hover': blend(palette.primary.main, palette.primary.dark, 0.5),\n 'solid-pressed': palette.primary.dark,\n 'solid-disabled': palette.action.disabledBackground,\n tint: 'transparent',\n 'tint-hover': alpha(palette.primary.main, 0.4),\n 'tint-pressed': alpha(palette.primary.main, 0.6),\n 'tint-disabled': palette.action.disabledBackground,\n danger: palette.error.light,\n warning: palette.warning.light,\n success: palette.success.light,\n }).forEach(([key, value]) => {\n styleObject[`--bui-bg-${key}`] = value;\n });\n\n // Border colors\n Object.entries({\n danger: palette.error.main,\n warning: palette.warning.main,\n success: palette.success.main,\n }).forEach(([key, value]) => {\n styleObject[`--bui-border-${key}`] = value;\n });\n\n // Base border color if available\n styleObject['--bui-border'] = palette.border || palette.divider;\n styleObject['--bui-border-danger'] = palette.error.main;\n styleObject['--bui-border-warning'] = palette.warning.main;\n styleObject['--bui-border-success'] = palette.success.main;\n\n // Special colors\n styleObject['--bui-ring'] = palette.highlight || palette.primary.main;\n\n return styleObject;\n}\n"],"names":[],"mappings":";;AA8BO,SAAS,qBACd,KAAA,EAC4B;AAC5B,EAAA,MAAM,WAAA,GAAc,qBAAqB,KAAK,CAAA;AAE9C,EAAA,MAAM,QAAA,GACJ,KAAA,CAAM,OAAA,CAAQ,IAAA,KAAS,SAAS,0BAAA,GAA6B,OAAA;AAE/D,EAAA,MAAM,GAAA,GAAM,GAAG,QAAQ,CAAA;AAAA,EAAO,OAAO,OAAA,CAAQ,WAAW,EACrD,GAAA,CAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM,CAAA,EAAA,EAAK,GAAG,CAAA,EAAA,EAAK,KAAK,GAAG,CAAA,CAC3C,IAAA,CAAK,IAAI,CAAC;AAAA,CAAA,CAAA;AAEb,EAAA,OAAO,EAAE,KAAK,WAAA,EAAY;AAC5B;AAKA,SAAS,qBAAqB,KAAA,EAA0C;AACtE,EAAA,MAAM,cAAsC,EAAC;AAG7C,EAAA,IAAI,KAAA,CAAM,WAAW,UAAA,EAAY;AAC/B,IAAA,WAAA,CAAY,oBAAoB,CAAA,GAAI,KAAA,CAAM,UAAA,CAAW,UAAA;AAAA,EACvD;AAGA,EAAA,IAAI,KAAA,CAAM,WAAW,iBAAA,EAAmB;AACtC,IAAA,WAAA,CAAY,2BAA2B,CAAA,GAAI,MAAA;AAAA,MACzC,MAAM,UAAA,CAAW;AAAA,KACnB;AAAA,EACF;AACA,EAAA,IAAI,KAAA,CAAM,WAAW,cAAA,EAAgB;AACnC,IAAA,WAAA,CAAY,wBAAwB,CAAA,GAAI,MAAA;AAAA,MACtC,MAAM,UAAA,CAAW;AAAA,KACnB;AAAA,EACF;AAEA,EAAA,MAAM,OAAA,GAAU,KAAA,CAAM,OAAA,CAAQ,CAAC,CAAA;AAE/B,EAAA,IAAI,YAAY,KAAA,EAAO;AACrB,IAAA,WAAA,CAAY,aAAa,CAAA,GAAI,CAAA,KAAA,EAAQ,OAAO,CAAA,OAAA,CAAA;AAAA,EAC9C;AAGA,EAAA,IAAI,KAAA,CAAM,KAAA,CAAM,YAAA,KAAiB,CAAA,EAAG;AAClC,IAAA,WAAA,CAAY,gBAAgB,CAAA,GAAI,GAAA;AAChC,IAAA,WAAA,CAAY,gBAAgB,CAAA,GAAI,GAAA;AAChC,IAAA,WAAA,CAAY,gBAAgB,CAAA,GAAI,GAAA;AAChC,IAAA,WAAA,CAAY,gBAAgB,CAAA,GAAI,GAAA;AAChC,IAAA,WAAA,CAAY,gBAAgB,CAAA,GAAI,GAAA;AAChC,IAAA,WAAA,CAAY,gBAAgB,CAAA,GAAI,GAAA;AAAA,EAClC;AAGA,EAAA,MAAM,UAAU,KAAA,CAAM,OAAA;AAItB,EAAA,WAAA,CAAY,aAAa,CAAA,GAAI,OAAA,CAAQ,MAAA,CAAO,KAAA;AAC5C,EAAA,WAAA,CAAY,aAAa,CAAA,GAAI,OAAA,CAAQ,MAAA,CAAO,KAAA;AAG5C,EAAA,MAAA,CAAO,OAAA,CAAQ;AAAA,IACb,OAAA,EAAS,QAAQ,IAAA,CAAK,OAAA;AAAA,IACtB,WAAW,OAAA,CAAQ,UAAA;AAAA,IACnB,IAAA,EAAM,OAAA,CAAQ,IAAA,IAAQ,OAAA,CAAQ,OAAA,CAAQ,IAAA;AAAA,IACtC,YAAA,EAAc,OAAA,CAAQ,SAAA,IAAa,OAAA,CAAQ,OAAA,CAAQ,IAAA;AAAA,IACnD,QAAA,EAAU,QAAQ,IAAA,CAAK,QAAA;AAAA,IACvB,KAAA,EAAO,QAAQ,OAAA,CAAQ,YAAA;AAAA,IACvB,gBAAA,EAAkB,QAAQ,IAAA,CAAK,QAAA;AAAA,IAC/B,MAAM,OAAA,CAAQ,UAAA;AAAA,IACd,iBAAiB,OAAA,CAAQ,cAAA;AAAA,IACzB,MAAA,EAAQ,QAAQ,KAAA,CAAM,IAAA;AAAA,IACtB,OAAA,EAAS,QAAQ,OAAA,CAAQ,IAAA;AAAA,IACzB,OAAA,EAAS,QAAQ,OAAA,CAAQ;AAAA,GAC1B,CAAA,CAAE,OAAA,CAAQ,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AAC3B,IAAA,WAAA,CAAY,CAAA,SAAA,EAAY,GAAG,CAAA,CAAE,CAAA,GAAI,KAAA;AAAA,EACnC,CAAC,CAAA;AAGD,EAAA,MAAA,CAAO,OAAA,CAAQ;AAAA,IACb,WAAA,EAAa,QAAQ,UAAA,CAAW,OAAA;AAAA,IAChC,WAAA,EAAa,QAAQ,UAAA,CAAW,KAAA;AAAA,IAChC,WAAA,EAAa,QAAQ,UAAA,CAAW,OAAA;AAAA,IAChC,WAAA,EAAa,QAAQ,UAAA,CAAW,OAAA;AAAA,IAChC,KAAA,EAAO,QAAQ,OAAA,CAAQ,IAAA;AAAA,IACvB,aAAA,EAAe,MAAM,OAAA,CAAQ,OAAA,CAAQ,MAAM,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAG,CAAA;AAAA,IACpE,eAAA,EAAiB,QAAQ,OAAA,CAAQ,IAAA;AAAA,IACjC,gBAAA,EAAkB,QAAQ,MAAA,CAAO,kBAAA;AAAA,IACjC,IAAA,EAAM,aAAA;AAAA,IACN,YAAA,EAAc,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAG,CAAA;AAAA,IAC7C,cAAA,EAAgB,KAAA,CAAM,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAG,CAAA;AAAA,IAC/C,eAAA,EAAiB,QAAQ,MAAA,CAAO,kBAAA;AAAA,IAChC,MAAA,EAAQ,QAAQ,KAAA,CAAM,KAAA;AAAA,IACtB,OAAA,EAAS,QAAQ,OAAA,CAAQ,KAAA;AAAA,IACzB,OAAA,EAAS,QAAQ,OAAA,CAAQ;AAAA,GAC1B,CAAA,CAAE,OAAA,CAAQ,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AAC3B,IAAA,WAAA,CAAY,CAAA,SAAA,EAAY,GAAG,CAAA,CAAE,CAAA,GAAI,KAAA;AAAA,EACnC,CAAC,CAAA;AAGD,EAAA,MAAA,CAAO,OAAA,CAAQ;AAAA,IACb,MAAA,EAAQ,QAAQ,KAAA,CAAM,IAAA;AAAA,IACtB,OAAA,EAAS,QAAQ,OAAA,CAAQ,IAAA;AAAA,IACzB,OAAA,EAAS,QAAQ,OAAA,CAAQ;AAAA,GAC1B,CAAA,CAAE,OAAA,CAAQ,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AAC3B,IAAA,WAAA,CAAY,CAAA,aAAA,EAAgB,GAAG,CAAA,CAAE,CAAA,GAAI,KAAA;AAAA,EACvC,CAAC,CAAA;AAGD,EAAA,WAAA,CAAY,cAAc,CAAA,GAAI,OAAA,CAAQ,MAAA,IAAU,OAAA,CAAQ,OAAA;AACxD,EAAA,WAAA,CAAY,qBAAqB,CAAA,GAAI,OAAA,CAAQ,KAAA,CAAM,IAAA;AACnD,EAAA,WAAA,CAAY,sBAAsB,CAAA,GAAI,OAAA,CAAQ,OAAA,CAAQ,IAAA;AACtD,EAAA,WAAA,CAAY,sBAAsB,CAAA,GAAI,OAAA,CAAQ,OAAA,CAAQ,IAAA;AAGtD,EAAA,WAAA,CAAY,YAAY,CAAA,GAAI,OAAA,CAAQ,SAAA,IAAa,QAAQ,OAAA,CAAQ,IAAA;AAEjE,EAAA,OAAO,WAAA;AACT;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-mui-to-bui",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "frontend-plugin",
|
|
6
6
|
"pluginId": "mui-to-bui",
|
|
@@ -39,15 +39,15 @@
|
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
41
|
"@backstage/core-plugin-api": "^1.12.1",
|
|
42
|
-
"@backstage/frontend-plugin-api": "^0.13.
|
|
42
|
+
"@backstage/frontend-plugin-api": "^0.13.3",
|
|
43
43
|
"@backstage/theme": "^0.7.1",
|
|
44
|
-
"@backstage/ui": "^0.
|
|
44
|
+
"@backstage/ui": "^0.11.0",
|
|
45
45
|
"@mui/material": "^5.12.2",
|
|
46
46
|
"@mui/system": "^5.16.14"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@backstage/cli": "^0.35.
|
|
50
|
-
"@backstage/dev-utils": "^1.1.
|
|
49
|
+
"@backstage/cli": "^0.35.2",
|
|
50
|
+
"@backstage/dev-utils": "^1.1.19",
|
|
51
51
|
"@backstage/test-utils": "^1.7.14",
|
|
52
52
|
"@testing-library/jest-dom": "^6.0.0",
|
|
53
53
|
"@testing-library/react": "^16.0.0",
|