# react-material-web

> A React Material components using material web and lit/react

Latest version **2.2.2** (published 2025-02-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-material-web
pnpm add react-material-web
yarn add react-material-web
bun add react-material-web
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.2 |
| Published | 2025-02-10 |
| First published | 2024-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 175.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Anthony Leung |
| Maintainers | anthonyleunghk |
| Keywords | material 3, material you, material web, material web react, react material component, material design, react, react material web, react material web component, react-material-web |

## Links

- npm: https://www.npmjs.com/package/react-material-web
- Repository: https://github.com/anthonyleung-dev/material-web-react
- Homepage: https://github.com/anthonyleung-dev/material-web-react#readme
- Issues: https://github.com/anthonyleung-dev/material-web-react/issues
- npm.io page: https://npm.io/package/react-material-web

## Dependencies (4)

- [@lit/react](https://npm.io/package/@lit/react.md) ^1.0.7
- [@material/web](https://npm.io/package/@material/web.md) ^2.2.0
- [material-symbols](https://npm.io/package/material-symbols.md) ^0.28.1
- [@fontsource/roboto](https://npm.io/package/@fontsource/roboto.md) ^5.1.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.2.2 (latest) — 2025-02-10
- 2.2.0 — 2024-10-02
- 2.0.0 — 2024-08-13
- 1.0.10 — 2024-05-31
- 1.0.9 — 2024-05-21
- 1.0.8 — 2024-04-16
- 1.0.7 — 2024-04-01
- 1.0.6 — 2024-04-01
- 1.0.5 — 2024-03-27
- 1.0.4 — 2024-03-27
- 1.0.3 — 2024-03-27
- 1.0.2 — 2024-03-27
- 1.0.1 — 2024-03-27
- 1.0.0 — 2024-03-27

## README

# React Material Web Components

This library provides a set of React components styled with Material Design, leveraging the capabilities of `@material/web` and `@lit/react`.

## Installation

To install Material Web React, you can use npm or yarn. Run one of the following commands in your project directory:

```bash
npm install react-material-web
```

or

```bash
yarn add react-material-web
```

## Usage

Here's a quick example to get you started. After installing, you can import and use Material Components like any other React component.

We default to using the `@fontsource/roboto` and `material-symbols` in styles, if you want to use them, you can import them in your project:
Add styles to your project:
```tsx
import 'react-material-web/styles'
```

Or you can use the components without default styles.

Then, you can use the components like this:

```tsx
import React from 'react';
import { MdFilledButton } from 'react-material-web';

function Example() {
  return (
    <div>
      <MdFilledButton>Click me</MdFilledButton>
    </div>
  );
}
```

For more detailed documentation on each component and its API, please refer to [Material Components Web](https://github.com/material-components/material-web).

## Storybook

You can also check out our Storybook to see all the components in action. To run the Storybook, use the following command:

```bash
npm run storybook
```

or

[Storybook](https://react-material-web.netlify.app)

## Available Components

### Base
- ✅ Button
- ✅ FAB
- ✅ Icon
- ✅ Icon button
- ✅ Checkbox
- ✅ Chips
- ✅ Dialog
- ✅ Divider
- ✅ Elevation
- ✅ Focus ring
- ✅ List
- ✅ Menu
- ✅ Progress indicators
- ✅ Radio
- ✅ Ripple
- ✅ Select
- ✅ Slider
- ✅ Switch
- ✅ Tabs
- ✅ Text field

### Labs 🚧
> WARNING ⚠️ This folder contains experimental features that are not recommended for production.
- ✅ Badge
- ✅ Card
- ✅ Segmented button
- ✅ Navigation bar

## Core Dependencies

Our library is built upon the solid foundation of Material Design and modern web technologies, including:

- **[@material/web](https://github.com/material-components/material-web):** For Material Design components.
- **[@lit/react](https://github.com/lit/lit):** For creating Lit-based components within React.
- **[@fontsource/roboto](https://github.com/fontsource/font-files/tree/main/fonts/google/roboto):** The default Material Design font.
- **[material-symbols](https://github.com/marella/material-symbols):** For Material Design icons and symbols.


## License

Distributed under the MIT License. See `LICENSE` for more information.

---
_Source: https://npm.io/package/react-material-web · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._