Material-UI theme for Squonk applications. Can be used independently with just Material-UI or with Emotion of Styled-Components.

Examples

Material UI

The colour scheme provides both a light and a dark theme. Mui v7 will automatically switch between schemes via media queries, taking into account the users system preference.

import { CssBaseline } from '@material-ui/core';
import { StylesProvider, ThemeProvider as MuiThemeProvider } from '@material-ui/core/styles';

import theme from '@squonk/mui-theme';

export const App = () => {
  return (
    <StylesProvider injectFirst>
      <CssBaseline />
      <MuiThemeProvider theme={theme}>
        {...}
      </MuiThemeProvider>
    </StylesProvider>
  );
};

Emotion

Wrap the previous example with the theme provider from emotion.

import { ThemeProvider } from '@emotion/react';

<ThemeProvider theme={theme}>{...}</ThemeProvider>

Release Strategy

• Conventional commit messages are used to trigger new builds
• Only feat and fix commit types will trigger a version bump
• Commits pushed to the branch dev will trigger a tagged dev build. E.g. 5.0.1-dev.1
• Commits pushed to the default branch (main) will trigger a "official" tag. E.g. 5.0.1
• The package.json version, changelog will be updated and a the new version will be published to npm.