| 1 |
|
| 2 | <p align="center">
|
| 3 | <a href="https://mui.com/base-ui/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="Base UI logo"></a>
|
| 4 | </p>
|
| 5 |
|
| 6 | <h1 align="center">Base UI</h1>
|
| 7 |
|
| 8 | Base UI is a library of headless ("unstyled") React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
|
| 9 |
|
| 10 | ## Installation
|
| 11 |
|
| 12 | Install the package in your project directory with:
|
| 13 |
|
| 14 | ```bash
|
| 15 | npm install @mui/base
|
| 16 | ```
|
| 17 |
|
| 18 | ## Documentation
|
| 19 |
|
| 20 |
|
| 21 |
|
| 22 | Visit [https://mui.com/base-ui/](https://mui.com/base-ui/) to view the full documentation.
|
| 23 |
|
| 24 | ## Questions
|
| 25 |
|
| 26 | For how-to questions that don't involve making changes to the code base, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/base-ui) instead of GitHub issues.
|
| 27 | Use the "base-ui" tag on Stack Overflow to make it easier for the community to find your question.
|
| 28 |
|
| 29 | ## Examples
|
| 30 |
|
| 31 | Our documentation features [a collection of example projects using Base UI](https://github.com/mui/material-ui/tree/master/examples).
|
| 32 |
|
| 33 | ## Contributing
|
| 34 |
|
| 35 | Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.
|
| 36 |
|
| 37 | Contributing to Base UI is about more than just issues and pull requests!
|
| 38 | There are many other ways to [support Base UI](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) beyond contributing to the code base.
|
| 39 |
|
| 40 | ## Changelog
|
| 41 |
|
| 42 | The [changelog](https://github.com/mui/material-ui/releases) is regularly updated to reflect what's changed in each new release.
|
| 43 |
|
| 44 | ## Roadmap
|
| 45 |
|
| 46 | Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/material-ui/discover-more/roadmap/).
|
| 47 |
|
| 48 | ## License
|
| 49 |
|
| 50 | This project is licensed under the terms of the
|
| 51 | [MIT license](/LICENSE).
|
| 52 |
|
| 53 | ## Security
|
| 54 |
|
| 55 | For details of supported versions and contact details for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/security/policy).
|