@docker/docker-mui-theme
TypeScript icon, indicating that this package has built-in type declarations

0.0.13 • Public • Published

@docker/docker-mui-theme

This package provides a Material UI theme that specifies the basic look & feel of Docker Desktop in an application-agnostic way. This is the only officially supported theming solution for Docker Extensions.

How to use

Wrap your React application with one of the two theme providers (see MUI Versions section below), and then render a MUI CssBaseline component somewhere within it.

For best results integrating with Docker Desktop, also read our MUI best practices article.

import { DockerMuiV6ThemeProvider } from '@docker/docker-mui-theme';
import CssBaseline from '@mui/material/CssBaseline';

function App() {
  return (
    <DockerMuiV6ThemeProvider>
      <CssBaseline />

      <YourAppContent />
    </DockerMuiV6ThemeProvider>
  );
}

MUI Versions

Docker Desktop currently primarily supports MUI v6, but has legacy support for MUI v5. When wrapping your app, use the appropriate context provider:

  • DockerMuiV6ThemeProvider for MUI v6
  • DockerMuiV5ThemeProvider for MUI v5

A future major version change will remove support for MUI v5.

Readme

Keywords

none

Package Sidebar

Install

npm i @docker/docker-mui-theme

Weekly Downloads

1,886

Version

0.0.13

License

Apache-2.0

Unpacked Size

16.4 kB

Total Files

7

Last publish

Collaborators

  • trungutt
  • rebecap-docker
  • rossipedia-docker
  • crazymax
  • lucas.bernalte.docker
  • lizzthabet
  • gtardif
  • ebriney
  • jeanlaurent
  • serjkarneichyk
  • rumpl
  • mark-dr