# Mantine Led Component

<img  alt="Mantine Led" src="https://github.com/gfazioli/mantine-led/blob/master/logo.jpeg" />

<div align="center">

  [![NPM version](https://img.shields.io/npm/v/%40gfazioli%2Fmantine-led?style=for-the-badge)](https://www.npmjs.com/package/@gfazioli/mantine-led)
  [![NPM Downloads](https://img.shields.io/npm/dm/%40gfazioli%2Fmantine-led?style=for-the-badge)](https://www.npmjs.com/package/@gfazioli/mantine-led)
  [![NPM Downloads](https://img.shields.io/npm/dy/%40gfazioli%2Fmantine-led?style=for-the-badge&label=%20&color=f90)](https://www.npmjs.com/package/@gfazioli/mantine-led)
  ![NPM License](https://img.shields.io/npm/l/%40gfazioli%2Fmantine-led?style=for-the-badge)

---

[<kbd> <br/> ❤️ If this component has been useful to you or your team, please consider becoming a sponsor <br/> </kbd>](https://github.com/sponsors/gfazioli?o=esc)  

</div>

## Overview

This component is created on top of the [Mantine](https://mantine.dev/) library.
It requires **Mantine 9.x** and **React 19**.

The [Mantine Led](https://gfazioli.github.io/mantine-led/) component is a highly customizable LED indicator for React applications built with Mantine. It provides visual feedback for status indicators, notifications, and interactive elements with support for various colors, sizes, animations, and states.

## Features

- 🎨 **Theme Integration**: Full Mantine theme support with all theme colors
- 📐 **Flexible Sizing**: Supports all Mantine sizes plus custom values
- 📱 **Responsive Props**: `Led.Matrix` supports responsive `cols` and `gap` via Mantine breakpoint objects (e.g. `{ base: 4, md: 8 }`)
- ✨ **Rich Animations**: Multiple animation types (pulse, flash, breathe, blink, glow)
- 🎭 **Visual Variants**: Flat and 3D rendering styles
- 🏷️ **Label Support**: Optional labels with configurable positioning
- 🎛️ **Controlled State**: Full control over the LED on/off state
- ♿ **Accessibility**: Follows WAI-ARIA best practices
- 🎨 **Styles API**: Extensive styling customization support
- 📦 **TypeScript**: Full type safety out of the box

> [!note]
>
> → [Demo and Documentation](https://gfazioli.github.io/mantine-led/) → [Youtube Video](https://www.youtube.com/playlist?list=PL85tTROKkZrWyqCcmNCdWajpx05-cTal4) → [More Mantine Components](https://mantine-extensions.vercel.app/)

## Installation

```sh
npm install @gfazioli/mantine-led
```
or 

```sh
yarn add @gfazioli/mantine-led
```

After installation import package styles at the root of your application:

```tsx
import '@gfazioli/mantine-led/styles.css';
```

## Usage

```tsx
import { Led } from '@gfazioli/mantine-led';

function Demo() {
  return  <Led />;
}
```

## Sponsor

<div align="center">

[<kbd> <br/> ❤️ If this component has been useful to you or your team, please consider becoming a sponsor <br/> </kbd>](https://github.com/sponsors/gfazioli?o=esc)

</div>

Your support helps me:

- Keep the project actively maintained with timely bug fixes and security updates	
- Add new features, improve performance, and refine the developer experience	
- Expand test coverage and documentation for smoother adoption	
- Ensure long‑term sustainability without relying on ad hoc free time	
- Prioritize community requests and roadmap items that matter most

Open source thrives when those who benefit can give back—even a small monthly contribution makes a real difference. Sponsorships help cover maintenance time, infrastructure, and the countless invisible tasks that keep a project healthy.

Your help truly matters.

💚 [Become a sponsor](https://github.com/sponsors/gfazioli?o=esc) today and help me keep this project reliable, up‑to‑date, and growing for everyone.