npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

google-material-icons

v2.0.1

Published

A google material icon library package for React applications

Downloads

200

Readme

Google Material Icons

Implementation of the google material icon library for react applications.

Installation

yarn add google-material-icons

or

npm install google-material-icons

How to use

It's built with ES modules so it's completely tree-shakable. Each icon can be imported as a react component with two different variant Filled and Outlined.

Example

You can pass additional props to adjust the icon.

import { Abc } from "google-material-icons/filled";

const App = () => {
  return <Abc color="red" size={48} />;
};

export default App;
import { Abc } from "google-material-icons/outlined";

const App = () => {
  return <Abc color="red" size={48} />;
};

export default App;

Props

| name | type | default | | ------------- | -------- | ------------ | | size | Number | 24 | | color | String | currentColor | | strokeWidth | Number | 2 |

Custom props

You can also pass custom props that will be added in the svg as attributes.

const App = () => {
  return <Abc fill="red" />;
};

Generic icon component

It is possible to create a generic icon component to load icons.

:warning: The example below is importing all ES modules. This is not recommended when you using a bundler since your application build size will grow substantially.

import { filledIcons } from "google-material-icons";

const Icon = ({ name, color, size }) => {
  const GoogleMaterialIcon = filledIcons[name];

  return <GoogleMaterialIcon color={color} size={size} />;
};

export default Icon;

With Dynamic Imports

Google Material Icons exports a dynamic import map dynamicIconImports. Useful for applications that want to show icons dynamically by icon name. For example when using a content management system with where icon names are stored in a database.

When using client side rendering, it will fetch the icon component when it's needed. This will reduce the initial bundle size.

The keys of the dynamic import map are the Google Material original icon names.

Example with React suspense:

import React, { lazy, Suspense } from "react";
import { GoogleMaterialProps } from "google-material-icons/outlined";
import outlinedDynamicIconImports from "google-material-icons/outlinedDynamicIconImports";

const fallback = <div style={{ background: "#ddd", width: 24, height: 24 }} />;

interface IconProps extends Omit<GoogleMaterialProps, "ref"> {
  name: keyof typeof outlinedDynamicIconImports;
}

const Icon = ({ name, ...props }: IconProps) => {
  const GoogleMaterialIcon = lazy(outlinedDynamicIconImports[name]);

  return (
    <Suspense fallback={fallback}>
      <GoogleMaterialIcon {...props} />
    </Suspense>
  );
};

export default Icon;
NextJS Example

In NextJS, the dynamic function can be used to dynamically load the icon component.

To make dynamic imports work with NextJS, you need to add google-material-icons to the transpilePackages option in your next.config.js like this:

/** @type {import('next').NextConfig} */
const nextConfig = {
  transpilePackages: ["google-material-icons"], // add this
};

module.exports = nextConfig;

You can then start using it:

import dynamic from "next/dynamic";
import { GoogleMaterialProps } from "google-material-icons/filled";
import filledDynamicIconImports from "google-material-icons/filledDynamicIconImports";

interface IconProps extends GoogleMaterialProps {
  name: keyof typeof filledDynamicIconImports;
}

const Icon = ({ name, ...props }: IconProps) => {
  const GoogleMaterialIcon = dynamic(filledDynamicIconImports[name]);

  return <GoogleMaterialIcon {...props} />;
};

export default Icon;