@backstage/theme 0.4.4 → 0.5.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @backstage/theme
 
+## 0.5.0-next.0
+
+### Minor Changes
+
+- 4d9e3b39e4: Added a global `OverrideComponentNameToClassKeys` for other plugins and packages to populate using module augmentation. This will in turn will provide component style override types for `createUnifiedTheme`.
+
 ## 0.4.4
 
 ### Patch Changes

package/dist/index.d.ts

@@ -3,9 +3,11 @@ import { ComponentsProps } from '@material-ui/core/styles/props';
 import { Theme, ThemeOptions, PaletteOptions as PaletteOptions$1 } from '@mui/material/styles';
 import { Theme as Theme$1, ThemeOptions as ThemeOptions$1 } from '@material-ui/core/styles';
 import { PaletteOptions, Palette } from '@material-ui/core/styles/createPalette';
+import * as _backstage_theme from '@backstage/theme';
 import { ReactNode } from 'react';
 import * as _material_ui_core from '@material-ui/core';
 import { ThemeOptions as ThemeOptions$2, Theme as Theme$2 } from '@material-ui/core';
+import { OverridesStyleRules } from '@mui/material/styles/overrides';
 
 /**
  * Transform Material UI v5 component themes into a v4 theme props and overrides.
@@ -219,8 +221,8 @@ declare function createUnifiedThemeFromV4(options: ThemeOptions$1): UnifiedTheme
  * @public
  */
 declare const themes: {
-    light: UnifiedTheme;
-    dark: UnifiedTheme;
+    light: _backstage_theme.UnifiedTheme;
+    dark: _backstage_theme.UnifiedTheme;
 };
 
 /**
@@ -571,6 +573,30 @@ declare function createThemeOverrides(theme: Theme$2): Overrides;
  */
 declare function createTheme(options: SimpleThemeOptions): Theme$2;
 
+declare module '@mui/private-theming/defaultTheme' {
+    interface DefaultTheme extends Theme {
+    }
+}
+/**
+ * Merge interface declarations into this type to register overrides for your components.
+ *
+ * @public
+ * @example
+ * ```ts
+ * declare module '@backstage/theme' {
+ *   interface OverrideComponentNameToClassKeys {
+ *     MyComponent: 'root' | 'header';
+ *   }
+ * }
+ * ```
+ */
+interface OverrideComponentNameToClassKeys {
+}
+type BackstageComponentOverrides = {
+    [TName in keyof OverrideComponentNameToClassKeys]?: {
+        styleOverrides?: Partial<OverridesStyleRules<OverrideComponentNameToClassKeys[TName], TName, Theme>>;
+    };
+};
 declare module '@mui/material/styles' {
     interface Palette extends BackstagePaletteAdditions {
     }
@@ -583,8 +609,8 @@ declare module '@mui/material/styles' {
     interface ThemeOptions extends Partial<BackstageThemeAdditions> {
     }
 }
-declare module '@mui/private-theming/defaultTheme' {
-    interface DefaultTheme extends Theme {
+declare module '@mui/material/styles' {
+    interface Components extends BackstageComponentOverrides {
     }
 }
 
@@ -595,4 +621,4 @@ declare module '@mui/private-theming/defaultTheme' {
  */
 declare const defaultComponentThemes: ThemeOptions['components'];
 
-export { BackstagePalette, BackstagePaletteAdditions, BackstagePaletteOptions, BackstageTheme, BackstageThemeAdditions, BackstageThemeOptions, BackstageTypography, BaseThemeOptionsInput, PageTheme, PageThemeSelector, SimpleThemeOptions, SupportedThemes, SupportedVersions, UnifiedTheme, UnifiedThemeOptions, UnifiedThemeProvider, UnifiedThemeProviderProps, colorVariants, createBaseThemeOptions, createTheme, createThemeOptions, createThemeOverrides, createUnifiedTheme, createUnifiedThemeFromV4, darkTheme, defaultComponentThemes, genPageTheme, lightTheme, pageTheme, palettes, shapes, themes, transformV5ComponentThemesToV4 };
+export { BackstagePalette, BackstagePaletteAdditions, BackstagePaletteOptions, BackstageTheme, BackstageThemeAdditions, BackstageThemeOptions, BackstageTypography, BaseThemeOptionsInput, OverrideComponentNameToClassKeys, PageTheme, PageThemeSelector, SimpleThemeOptions, SupportedThemes, SupportedVersions, UnifiedTheme, UnifiedThemeOptions, UnifiedThemeProvider, UnifiedThemeProviderProps, colorVariants, createBaseThemeOptions, createTheme, createThemeOptions, createThemeOverrides, createUnifiedTheme, createUnifiedThemeFromV4, darkTheme, defaultComponentThemes, genPageTheme, lightTheme, pageTheme, palettes, shapes, themes, transformV5ComponentThemesToV4 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/theme",
   "description": "material-ui theme for use with Backstage.",
-  "version": "0.4.4",
+  "version": "0.5.0-next.0",
   "publishConfig": {
     "access": "public",
     "main": "dist/index.esm.js",
@@ -44,7 +44,10 @@
     "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.24.0",
+    "@backstage/cli": "^0.24.1-next.0",
+    "@mui/styles": "^5.14.18",
+    "@testing-library/jest-dom": "^6.0.0",
+    "@testing-library/react": "^14.0.0",
     "@types/react": "^16.13.1 || ^17.0.0"
   },
   "files": [