跳转到内容

@material-ui/styled-engine

Configuring your preferred styling library.

The default style library used for generating CSS styles for Material-UI components is emotion. All of the Material-UI components rely on the styled() API to inject CSS into the page. This API is supported by multiple popular styling libraries, which makes it possible to switch between them in Material-UI.

How to switch to styled-components

If you already have styled-components installed, it's possible to use it exclusively. There are currently two packages available to choose from:

  • @material-ui/styled-engine - a thin wrapper around emotion's styled() API, with the addition of few other required utilities, such as the <GlobalStyles /> component, the css and keyframe helpers, etc. This is the default.
  • @material-ui/styled-engine-sc - a similar wrapper around styled-components.

These two packages implement the same interface, which makes it makes possible to replace one with the other. By default, @material-ui/core has @material-ui/styled-engine as a dependency, but you can configure your bundler to replace it with @material-ui/styled-engine-sc. For example, if you are using webpack you can configure this by adding a resolver:

webpack.config.js

module.exports = {
  //...
  resolve: {
    alias: {
      '@material-ui/styled-engine': '@material-ui/styled-engine-sc',
    },
  },
};

If you are using create-react-app, there is a ready-to-use template in the example projects. You can use the create-react-app-with-styled-components example, or its TypeScript equivalent.

Note: @emotion/react, @emotion/styled, and styled-components are optional peer dependencies of @material-ui/core, so you need to install them yourself. See the Installation guide for more info.

Note: This package-swap approach is identical to the replacement of React with Preact. The Preact team has documented a large number of installation configurations. If you are stuck with Material-UI + styled-components, don't hesitate to check out how they solve the problem, as you can likely transfer the solution.