Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 1.46 KB

README.md

File metadata and controls

54 lines (35 loc) · 1.46 KB
Raw

Material Design Icons Literal Types

This package provides TypeScript literal types for the icon names from the Google Material Design Icons repository. It allows you to use the icon names with type safety in your TypeScript projects.

Installation

Install the package

npm install -D material-design-icons-literal-types
pnpm add -D material-design-icons-literal-types
yarn add -D material-design-icons-literal-types

Usage

Import the desired icon type from the package

import {MaterialSymbols} from 'material-design-icons-literal-types'

const mySymbol: MaterialSymbols = 'home'
import {MaterialIcons} from 'material-design-icons-literal-types'

const myIcon: MaterialIcons = 'home'

The package provides the following literal types:

  • MaterialSymbols: Icon names for the Material Symbols icon set.
  • MaterialIcons: Icon names for the Material Icons icon set.

Using these literal types ensures that you are using valid icon names and helps catch typos during development.

Updating Icon Types

The icon types are automatically updated every Monday, Wednesday, and Friday at midnight (UTC) through a GitHub Actions workflow. This ensures that the package stays up to date with the latest icons from the Material Design Icons repository.

License

This project is licensed under the ISC License - see the LICENSE file for details.