Skip to content

Latest commit

 

History

History
149 lines (112 loc) · 4.45 KB

README.md

File metadata and controls

149 lines (112 loc) · 4.45 KB
Raw

MUI Core logo

mui-symbols-material

This package provides the Google Material Symbols converted to SvgIcon components.

Installation

Install the package in your project directory with:

npm install @mui-symbols-material/w400

To install icons of a different weight, simply replace 400 with the desired weight in the installation command.

These components use the Material UI's SvgIcon component to render the SVG path for each icon.

If you are not already using Material UI in your project, you can add it with:

npm install @mui/material

Usage

Once installed, you can use the icons in your React components:

import React from 'react';
import { 
  FavoriteOutlined, 
  FavoriteRounded, 
  FavoriteSharp, 
  FavoriteFilledOutlined, 
  FavoriteFilledRounded, 
  FavoriteFilledSharp,
} from '@mui-symbols-material/w400'; // Replace 400 with your desired weight

/**
 * Renders all variants of the favorite icon from Material Symbols.
 */
function MyComponent() {
  return (
    <>
      <FavoriteOutlined />
      <FavoriteRounded />
      <FavoriteSharp />
      <FavoriteFilledOutlined />
      <FavoriteFilledRounded />
      <FavoriteFilledSharp />
    </>
  );
}

Available Weights

The following weights are available, providing a range of design options:

  • @mui-symbols-material/w100
  • @mui-symbols-material/w200
  • @mui-symbols-material/w300
  • @mui-symbols-material/w400
  • @mui-symbols-material/w500
  • @mui-symbols-material/w600
  • @mui-symbols-material/w700

Styles

  1. Outlined: These icons have a distinct outline, providing a clear and crisp appearance.
  2. Rounded: These icons have rounded edges, offering a softer and more subtle appearance.
  3. Sharp: These icons have sharp edges, giving a bold and striking appearance.

Filled Version

Each icon also comes in a filled version, providing a different aesthetic and allowing for greater versatility in their usage.

Design Specifications

All icons are based on a standard 24px optical size and a default 0 grade.

Pure-ESM Package Versions

Standard packages include CJS and ESM versions that double the package size. For projects optimizing for performance and build efficiency, especially in environments with resource constraints like CI/CD pipelines, we now offer ESM-only versions of our icon sets. These versions contain only ECMAScript Module files and are about half the size of their standard counterparts, ensuring faster installation and less memory usage.

ESM-only versions are available for all weights to optimize performance:

  • @mui-symbols-material/w100-esm
  • @mui-symbols-material/w200-esm
  • @mui-symbols-material/w300-esm
  • @mui-symbols-material/w400-esm
  • @mui-symbols-material/w500-esm
  • @mui-symbols-material/w600-esm
  • @mui-symbols-material/w700-esm

To use the ESM-only version, append -esm to the package name during installation. Here's how you can install and use the ESM version:

npm install @mui-symbols-material/w400-esm

Once installed, you can import the icons from the ESM package like this:

import React from 'react';
import { 
  FavoriteOutlined, 
  FavoriteRounded, 
  FavoriteSharp, 
  FavoriteFilledOutlined, 
  FavoriteFilledRounded, 
  FavoriteFilledSharp,
} from '@mui-symbols-material/w400-esm'; // Using ESM version

function MyComponent() {
  return (
    <>
      <FavoriteOutlined />
      <FavoriteRounded />
      <FavoriteSharp />
      <FavoriteFilledOutlined />
      <FavoriteFilledRounded />
      <FavoriteFilledSharp />
    </>
  );
}

Documentation

Contributing

This icon set is meant to be in sync with Google's Material Symbols. Therefore, we don't accept fixes, additions, or any other contributions that would make this package diverge from the source.

To synchronize with Material Icons, do the following:

  1. Inside the root run pnpm download
  2. Inside the root run pnpm build