Repository: mantinedev/mantine

Stars: 31022

CLAUDE.md Copy Chapter

CLAUDE.md

Links Copy Chapter

- Testing guidelines – llms/testing.md

Finalizing Your Work Copy Chapter

Choose these commands to run after finalizing your work:

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 Copy Chapter

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 Copy Chapter

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 Copy Chapter

<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">
^{Special thanks to:}
<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>
^{No deep React knowledge required.}
</a>
</div>

Mantine


Links Copy Chapter

- Documentation
- Contribute
- Ask question or give feedback
- Changelog
- Follow on X
- Join Discord community

Packages Copy Chapter

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

Getting help Copy Chapter

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

- Join Discord community – it is the easiest way to get help, all questions are usually answered in about 30 minutes
- GitHub Discussions – ask anything about the project or give feedback

Contributors Copy Chapter

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

Become a contributor

Support development Copy Chapter


Mantine is a MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider contributing financially on OpenCollective.


License Copy Chapter

MIT