# Repository: mantinedev/mantine
# Stars: 31022

## CLAUDE.md

# CLAUDE.md

## Links

- Testing guidelines – `llms/testing.md`

## Finalizing Your Work

Choose these commands to run after finalizing your work:

```bash
# Always run these commands before finalizing your work
npm run typecheck
npx oxlint path/to/changed/files
npm run format:write:files path/to/changed/files

# Run tests for specific path related to your changes
npm run jest @mantine/charts
npm run jest path/to/changed/file.test.ts

# Run stylelint only if you have made changes to styles or CSS files
npm run stylelint

# Run this script if you've changed dependencies in any package.json
npm run syncpack
```

After running the commands above, check if `codex` CLI is available (`command -v codex`). If it is, run `/codex-code-review` to get an automated code review of unstaged changes and apply fixes.

## Code Style

**Comments Guidelines:**
- **Do not include inline comments** that describe logic or implementation details unless explicitly requested
- **Always preserve documentation comments** on interfaces, types, and function parameters (JSDoc-style comments with `/** */`)
- The codebase prefers clean, self-documenting code for implementation
- Type definitions and public APIs should maintain their documentation comments

## Commit conventions

Mantine is a monorepo, thus it is important to write correct commit messages to keep the git history clean and consistent. All commits made in this repository are divided into 3 groups:

- package commits – Related to any particular package.
- docs commits – Related to the documentation.
- core commits – Only related to repository tooling and not associated with any package.

Commit messages consists of 3 parts:
```
[area] Optional title: Message
```

Examples:
- `[core] Fix documentation deployment script` – Change made in repository script, it is not related to documentation or any package
- `[mantine.dev] Update report issues link` – Change related to documentation website
- `[@mantine/core] Button: Add theme focus styles` – Change in @mantine/core package at Button component
- `[@mantine/hooks] use-list-state: Add remove handler` – Change in @mantine/hooks package at use-list-state hook


## README.md

<div align="center">
	<a href="https://formengine.io/documentation/components-library/mantine/?utm_source=github&utm_medium=hero-banner&utm_campaign=mantine-readme-core#getting-started-with-mantine-components" target="_blank">
		<sup>Special thanks to:</sup>
		<br>
		<img alt="Formengine sponsorship" width="400" src="https://formengine.io/ads-images/mantine3.png?version=1">
		<br>
		<h>FormEngine Core – Lightweight React JSON Schema form builder library for Mantine</b>
		<br>
		<sup>No deep React knowledge required.</sup>
	</a>
</div>

# Mantine

[![NPM](https://img.shields.io/npm/l/@mantine/core)](https://github.com/mantinedev/mantine/blob/master/LICENSE)
[![Backers](https://opencollective.com/mantinedev/backers/badge.svg)](https://opencollective.com/mantinedev)
[![GitHub contributors](https://img.shields.io/github/contributors/mantinedev/mantine)](https://github.com/mantinedev/mantine/graphs/contributors)
[![npm](https://img.shields.io/npm/v/@mantine/core)](https://www.npmjs.com/package/@mantine/core)
[![npm](https://img.shields.io/npm/dm/@mantine/hooks)](https://www.npmjs.com/package/@mantine/hooks)
[![Help wanted](https://img.shields.io/github/labels/mantinedev/mantine/help%20wanted?label=Contribute)](https://github.com/mantinedev/mantine/labels/help%20wanted)
[![Discord](https://img.shields.io/badge/Chat%20on-Discord-%235865f2)](https://discord.gg/wbH82zuWMN)
[![X Follow](https://img.shields.io/twitter/follow/mantinedev?style=social)](https://x.com/mantinedev)

## Links

- [Documentation](https://mantine.dev/)
- [Contribute](https://mantine.dev/contribute)
- [Ask question or give feedback](https://github.com/mantinedev/mantine/discussions)
- [Changelog](https://mantine.dev/changelog/all-releases)
- [Follow on X](https://x.com/mantinedev)
- [Join Discord community](https://discord.gg/wbH82zuWMN)

## Packages

- [`@mantine/hooks`](https://mantine.dev/hooks/package/) – collection of 80+ hooks for state and UI management
- [`@mantine/core`](https://mantine.dev/core/package/) – core components library – 100+ components
- [`@mantine/form`](https://mantine.dev/form/use-form) – forms management library
- [`@mantine/charts`](https://mantine.dev/charts/getting-started/) – recharts based charts library
- [`@mantine/notifications`](https://mantine.dev/x/notifications) – a fully featured notifications system
- [`@mantine/spotlight`](https://mantine.dev/x/spotlight) – `Ctrl + K` command center for your application
- [`@mantine/code-highlight`](https://mantine.dev/x/code-highlight/) – code highlight built with [highlight.js](https://highlightjs.org/)
- [`@mantine/tiptap`](https://mantine.dev/x/tiptap) – a Tiptap based rich text editor
- [`@mantine/dropzone`](https://mantine.dev/x/dropzone) – manages files drag 'n' drop to an area or entire screen
- [`@mantine/carousel`](https://mantine.dev/x/carousel) – Carousel component
- [`@mantine/nprogress`](https://mantine.dev/x/nprogress) – navigation progress
- [`@mantine/modals`](https://mantine.dev/x/modals) – centralized modals manager
- [`@mantine/schedule`](https://mantine.dev/x/schedule) – Schedule component for displaying events

## Getting help

Mantine has a very friendly community, we are always happy to help you get started:

- [Join Discord community](https://discord.gg/wbH82zuWMN) – it is the easiest way to get help, all questions are usually answered in about 30 minutes
- [GitHub Discussions](https://github.com/mantinedev/mantine/discussions) – ask anything about the project or give feedback

## Contributors

<a href="https://github.com/mantinedev/mantine/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=mantinedev/mantine" />
</a>

[Become a contributor](https://mantine.dev/contribute)

## Support development

[![Backers](https://opencollective.com/mantinedev/backers/badge.svg)](https://opencollective.com/mantinedev)

Mantine is a MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome [backers](https://opencollective.com/mantinedev). If you'd like to join them, please consider contributing financially on [OpenCollective](https://opencollective.com/mantinedev).

[![Backers](https://opencollective.com/mantinedev/individuals.svg?width=890)](https://opencollective.com/mantinedev)

## License

MIT