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

Once installed, you can use the icons in your React components. Here's an example showing how to use icons of two different weights:

import React from 'react';
import { FavoriteOutlined as FavoriteRegular } from '@mui-symbols-material/w400'; // Regular weight
import { FavoriteOutlined as FavoriteBold } from '@mui-symbols-material/w700'; // Bold weight

function MyComponent() {
  return (
    <div>
      <FavoriteRegular /> {/* Regular weight icon */}
      <FavoriteBold /> {/* Bold weight icon */}
    </div>
  );
}

Styles

Outlined: These icons have a distinct outline, providing a clear and crisp appearance.
Rounded: These icons have rounded edges, offering a softer and more subtle appearance.
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.

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:

Inside the root run pnpm download
Inside the root run pnpm build

mbernardeau/mui-symbols-material