@opengeoweb/theme 9.8.0 → 9.9.0

package/README.md

@@ -14,7 +14,7 @@ The aim of this library is to make sure all MUI components look as specified in
 - [Folder structure](#folder-structure)
   - [Icons `(lib/components/Icons/Icons.tsx)`](#icons---lib-components-icons-iconstsx--)
   - [types `(lib/components/Theme/types.ts)`](#types---lib-components-theme-typests--)
-  - [themes `(lib/components/Theme/darkTheme.ts, .../lightTheme.ts, .../gwTheme.ts)`](#themes---lib-components-theme-darkthemets---lightthemets---gwthemets--)
+  - [themes `(lib/components/Theme/darkTheme.ts, .../lightTheme.ts)`](#themes---lib-components-theme-darkthemets---lightthemets--)
   - [ThemeContext `(lib/components/Theme/ThemeContext)`](#themecontext---lib-components-theme-themecontext--)
   - [utils `(lib/components/Theme/utils.ts)`](#utils---lib-components-theme-utilsts--)
   - [stories `(lib/stories)`](#stories---lib-stories--)
@@ -195,7 +195,7 @@ const drawBackground = (
 
 ### Using themes in stories
 
-When using a component which relies on theme styling, wrap the main component of your story with the `ThemeWrapper` component instead of `ThemeProvider`. `ThemeWrapper` will later get an extra `StyleEngineProvider` parent component (see https://mui.com/guides/migration-v4/#style-library). For components with old GWTheme styline, you can use `ThemeWrapperOldTheme`.
+When using a component which relies on theme styling, wrap the main component of your story with the `ThemeWrapper` component instead of `ThemeProvider`. `ThemeWrapper` will later get an extra `StyleEngineProvider` parent component (see https://mui.com/guides/migration-v4/#style-library).
 
 If you need to show multiple stories and don't want to see the default background, use the `disableCssBaseline` property to prevent that.
 
@@ -221,7 +221,6 @@ export const TableDark = (): React.ReactElement => (
 // lib/components/Icons/Icons.tsx
 // lib/components/Theme/darkTheme.ts
 // lib/components/Theme/lighTheme.ts
-// lib/components/Theme/gwTheme.ts
 // lib/components/Theme/utils.ts
 // lib/components/Theme/types.ts
 // lib/components/Theme/ThemeContext.tsx
@@ -239,15 +238,15 @@ All icons are defined here.
 
 Defines the color palette of the theme.
 
-#### themes `(lib/components/Theme/darkTheme.ts, .../lightTheme.ts, .../gwTheme.ts)`
+#### themes `(lib/components/Theme/darkTheme.ts, .../lightTheme.ts)`
 
-Exports files containing all the values per theme. Every color added to light or dark will automatically be inserted into gwTheme to maintain backwards compatibility while finishing the theme colors.
+Exports files containing all the values per theme.
 
 #### ThemeContext `(lib/components/Theme/ThemeContext)`
 
 - exports `ThemeProvider` wrapper for all MUI components including a `CssBaseline` component of MUI.
 - exports an `useThemeContext` to switch themes.
-- exports `ThemeWrapper` wrapper for stories and `ThemeWrapperOldTheme` wrapper for stories with old GWTheme (to be deprecated)
+- exports `ThemeWrapper` wrapper for stories
 
 #### utils `(lib/components/Theme/utils.ts)`
 
@@ -459,22 +458,9 @@ This footer is only used for when the wrapper is resizable. Therefore it would m
 ## Known issues
 
 - **Expect unit tests to fail** when using components with the theme. This is easily fixed by wrapping your test with the `ThemeProvider` from the `theme` lib. Don't import the ThemeProvider wrapper in the failed test, but use the `CoreThemeProvider` or `CoreThemeStoreProvider` found in [`libs/core/src/lib/components/Providers/Providers.tsx`](https://gitlab.com/opengeoweb/opengeoweb/-/blob/master/libs/core/src/lib/components/Providers/Providers.tsx#L36)
-- There are some **storybook bugs** with stories with Themes. When switching stories with new and old theme, it could be possible that some colors are rendered wrong. This is probably happening because one of the stories with old theme has `React.Strictmode` activated. This is only happening in storybook, and when refreshing page the colors should be correct. This will fix itself when we have `gwTheme` removed.
 - **MUI 5** makes it easy to add custom variants to components, so we should wait for that release before investing more heavy in theme stories: https://next.material-ui.com/customization/theme-components/#adding-new-component-variants . Check the progress of the release of [v5 here](https://github.com/mui-org/material-ui/milestone/44)
 - The `ThemeProvider` imports the **CssBaseline** components which allows us to set a body background and also resets some initial browser styling values. One thing it's resetting is the css **box-sizing** property. If you experience misaligning in (canvas) components, this might be the property you want to check out.
 
-## Roadmap
-
-Theming will be never be finished as it is an ongoing progress. The goal is to have the `gwTheme` removed, and only use `lightTheme` and `darkTheme` throughout all libs and apps. The following points need to be done to reach that:
-
-Other libs where `ThemeProvider` from `theme` should be used and `gwTheme` should be replaced:
-
-- [ ] airmet/sigmet (**TICKET TO BE CREATED**)
-- [ ] spaceweather (**TICKET TO BE CREATED**)
-- [ ] taf (**TICKET TO BE CREATED**)
-- [ ] form-fields (**TICKET TO BE CREATED**)
-- [ ] shared (**TICKET TO BE CREATED**)
-
 ## Unit testing
 
 ```