Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

Installation

Install Material-UI, the world's most popular React UI framework.

Material-UI is available as an npm package.

npm

To install and save in your package.json dependencies, run:

// with npm
npm install @material-ui/core

// with yarn
yarn add @material-ui/core

Please note that react >= 16.8.0 and react-dom >= 16.8.0 are peer dependencies.

Roboto Font

Material-UI was designed with the Roboto font in mind. So be sure to follow these instructions. For instance, via Google Web Fonts:

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" />

Font Icons

In order to use the font Icon component, you must first add the Material icons font. Here are some instructions on how to do so. For instance, via Google Web Fonts:

<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" />

SVG Icons

In order to use prebuilt SVG Material icons, such as those found in the icons demos you must first install the @material-ui/icons package:

// with npm
npm install @material-ui/icons

// with yarn
yarn add @material-ui/icons

CDN

You can start using Material-UI with minimal Front-end infrastructure, which is great for prototyping.

Two Universal Module Definition (UMD) files are provided:

You can follow this CDN example to quickly get started.

⚠️ Using this approach in production is discouraged though - the client has to download the entire library, regardless of which components are actually used, affecting performance and bandwidth utilization.

⚠️ The UMD links are using the latest tag to point to the latest version of the library. This pointer is unstable, it shifts as we release new versions. You should consider pointing to a specific version, such as v4.4.0.

Design resources

figma sketch adobe-xd

A set of reusable components for design tools is available, designed to match the React components, and to help you craft great products:

  • Figma: A large UI kit with over 600 handcrafted Material-UI components.
  • Sketch: A large UI kit with over 600 handcrafted Material-UI symbols.
  • Adobe XD: A large UI kit with over 600 handcrafted Material-UI symbols.
  • Framer: A small free UI kit of Material-UI components.