Warning
Only React 18 is supported. This package is not compatible with earlier or later versions of React. If you want to use this package without React 18, please build it from source.
A React package that brings the beautiful Material Icon Theme from VS Code to your React applications. This package extracts and adapts the complete icon system from the popular VS Code Material Icon Theme extension.
- 🎨 1000+ Material Design Icons - Complete set of file, folder, and language icons
- ⚛️ React Components - Easy-to-use React components with TypeScript support
- 🎯 Smart Icon Detection - Automatically matches icons based on file extensions, names, or language IDs
- 🎨 Theme Support - Multiple icon packs (Angular, React, Vue, etc.) and light/dark variants
- 🎛️ Customizable - Adjustable size, color, opacity, and saturation
- 📦 Lightweight - Minimal dependencies, optimized bundle size
- 🔧 Developer Friendly - Full TypeScript support and comprehensive API
npm install react-material-icon-theme
# or
yarn add react-material-icon-theme
# or
pnpm add react-material-icon-theme
import { MaterialIcon, FileIcon, FolderIcon } from 'react-material-icon-theme';
function App() {
return (
<div>
{/* Basic icon */}
<MaterialIcon name="typescript" size={32} />
{/* Auto-detected file icon */}
<FileIcon fileName="app.tsx" size={24} />
{/* Auto-detected folder icon */}
<FolderIcon folderName="src" size={24} />
</div>
);
}
The base icon component for displaying any icon by name.
<MaterialIcon
name="typescript"
size={32}
color="#3178c6"
opacity={0.8}
light={false}
onClick={() => console.log('Icon clicked')}
/>
Props:
-
name
(string): Icon SVG file name without extension -
size
(number | string): Icon size in pixels -
color
(string): Icon color (CSS color value) -
opacity
(number): Icon opacity (0-1) -
light
(boolean): Use light variant if available -
className
(string): Additional CSS class -
style
(CSSProperties): Additional styles -
onClick
(function): Click handler
Automatically detects and displays the appropriate icon for files.
<FileIcon
fileName="package.json"
size={24}
/>
<FileIcon
fileExtension="tsx"
size={24}
/>
<FileIcon
languageId="typescript"
size={24}
/>
Props:
- Inherits all
MaterialIcon
props exceptname
-
fileName
(string): Complete file name with extension -
fileExtension
(string): File extension (with or without dot) -
languageId
(string): Language identifier -
fallback
(string): Fallback icon name if no match found -
iconPack
(string): Active icon pack
Displays appropriate folder icons with support for open/closed states.
<FolderIcon
folderName="src"
isOpen={true}
size={24}
/>
<FolderIcon
isRoot={true}
theme="specific"
size={24}
/>
Props:
- Inherits all
MaterialIcon
props exceptname
-
folderName
(string): Folder name -
isRoot
(boolean): Whether this is a root folder -
isOpen
(boolean): Whether folder is open/expanded -
theme
(string): Folder theme ('specific', 'classic', 'none') -
fallback
(string): Fallback icon name
A component for browsing and selecting from available icons.
<IconBrowser
maxIcons={100}
searchFilter="react"
iconSize={32}
columns={8}
onIconClick={(iconName) => console.log('Selected:', iconName)}
/>
import {
getFileIcon,
getFolderIcon,
getAvailableFileExtensions,
getAvailableFileNames
} from 'react-material-icon-theme';
// Get icon name for a file
const iconName = getFileIcon({
fileName: 'app.tsx',
iconPack: 'react'
});
// Get all available file extensions
const extensions = getAvailableFileExtensions();
# Install dependencies
npm install
# Start development server
npm run dev
# Build library
npm run build
# Run tests
npm test
MIT - This package is based on the VS Code Material Icon Theme which is also MIT licensed.
Contributions are welcome! Please feel free to submit a Pull Request.
This package is based on the excellent Material Icon Theme VS Code extension by Philipp Kief and the Material Extensions team.