@backstage/theme
material-ui theme for use with Backstage
Functions
| Function | Description |
|---|---|
| createBaseThemeOptions(options) | A helper for creating theme options. |
| createTheme(options) | The old method to create a Backstage Material UI v4 theme using a palette. The theme is created with the common Backstage options and component styles. |
| createThemeOptions(options) | An old helper for creating Material UI v4 theme options. |
| createThemeOverrides(theme) | * An old helper for creating Material UI v4 theme overrides. |
| createUnifiedTheme(options) | Creates a new UnifiedTheme using the provided options. |
| createUnifiedThemeFromV4(options) | Creates a new UnifiedTheme using Material UI v4 theme options. Note that this uses adaptV4Theme from Material UI v5, which is deprecated. |
| genPageTheme(props) | Utility to not have to write colors and shapes twice. |
| transformV5ComponentThemesToV4(theme, components) | Transform Material UI v5 component themes into a v4 theme props and overrides. |
| UnifiedThemeProvider(props) | Provides themes for all Material UI versions supported by the provided unified theme. |
Interfaces
| Interface | Description |
|---|---|
| BackstageTheme | A Backstage theme. |
| BackstageThemeOptions | Backstage theme options. |
| BaseThemeOptionsInput | Options for createBaseThemeOptions(). |
| OverrideComponentNameToClassKeys | Merge interface declarations into this type to register overrides for your components. |
| UnifiedTheme | A container of one theme for multiple different Material UI versions. Currently known keys are 'v4' and 'v5'. |
| UnifiedThemeOptions | Options for creating a new UnifiedTheme. |
| UnifiedThemeProviderProps | Props for UnifiedThemeProvider(). |
Variables
| Variable | Description |
|---|---|
| colorVariants | The color range variants that are used in e.g. colorful bursts. |
| darkTheme | The old Material UI v4 Backstage dark theme. |
| defaultComponentThemes | A helper for creating theme overrides. |
| defaultTypography | Default Typography settings. |
| lightTheme | The old Material UI v4 Backstage light theme. |
| pageTheme | All of the builtin page themes. |
| palettes | Built-in Backstage color palettes. |
| shapes | The default predefined burst shapes. |
| themes | Built-in Backstage Material UI themes. |
Type Aliases
| Type Alias | Description |
|---|---|
| BackstagePalette | The full Backstage palette. |
| BackstagePaletteAdditions | Backstage specific additions to the material-ui palette. |
| BackstagePaletteOptions | The full Backstage palette options. |
| BackstageThemeAdditions | Backstage specific additions to the material-ui theme. |
| BackstageTypography | Custom Typography |
| PageTheme | The theme definitions for a given layout page. |
| PageThemeSelector | Selector for what page theme to use. |
| SimpleThemeOptions | A simpler configuration for creating a new theme that just tweaks some parts of the backstage one. |
| SupportedThemes | Supported Material UI Theme Types for SupportedVersions |
| SupportedVersions | Supported Material UI Versions Currently: 'v4' and 'v5'. |