https://github.com/mineral-ui/mineral-ui
A design system and React component library for the web brought to you by CA Technologies.
https://github.com/mineral-ui/mineral-ui
accessibility components design-systems mineral-ui react
Last synced: 6 months ago
JSON representation
A design system and React component library for the web brought to you by CA Technologies.
- Host: GitHub
- URL: https://github.com/mineral-ui/mineral-ui
- Owner: mineral-ui
- License: apache-2.0
- Created: 2017-04-10T15:29:20.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T17:57:27.000Z (over 3 years ago)
- Last Synced: 2024-05-16T13:42:22.770Z (about 2 years ago)
- Topics: accessibility, components, design-systems, mineral-ui, react
- Language: JavaScript
- Homepage: http://mineral-ui.netlify.com
- Size: 14.4 MB
- Stars: 556
- Watchers: 25
- Forks: 48
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.com/mineral-ui/mineral-ui)
[](https://david-dm.org/mineral-ui/mineral-ui)
[](https://github.com/commitizen/cz-cli)
[](https://github.com/prettier/prettier)
# Mineral UI
[Mineral UI](https://mineral-ui.com/) is a design system and [React](https://reactjs.org/) component library for the web that lets you quickly build high-quality, accessible apps.
> [ℹ️▶️ **Please read**: Important updates regarding the status of this project](./docs/status-of-mineral-ui.md)
## Project Goals
- Consistent, thoughtful design
- Accessible and inclusive
- Performant
- Responsive
- Powerful and easy to develop with inside your app
## Getting Started
### Installation
Install the [Mineral UI package](https://www.npmjs.com/package/mineral-ui) and
its dependencies.
```bash
npm install mineral-ui emotion-theming @emotion/core @emotion/is-prop-valid @emotion/styled react react-dom
```
or
```bash
yarn add mineral-ui emotion-theming @emotion/core @emotion/is-prop-valid @emotion/styled react react-dom
```
### Usage
```jsx
import React from 'react';
import { render } from 'react-dom';
import Button from 'mineral-ui/Button';
import { ThemeProvider } from 'mineral-ui/themes';
function App() {
return (
Hello World
);
}
render(, document.getElementById('app'));
```
> Your app must be wrapped in a [ThemeProvider](https://mineral-ui.com/components/theme-provider/) at its root in order for the styles to apply correctly.
> Also, please see our [import syntax guide](https://mineral-ui.com/import-syntax).
### Open Sans Font
Mineral UI was designed around [Open Sans](https://fonts.google.com/specimen/Open+Sans). To get the components to look right, you will need to include this font in your project yourself or our styles will fall back to system fonts. To quickly include this font in your app, copy this code into the `` of your HTML document.
```html
```
For more options loading this font from Google, check out the Selected Family popup, in the [specimen](https://fonts.google.com/specimen/Open+Sans?selection.family=Open+Sans). You can also download the font file and serve it yourself if you'd like, but we'll leave that to you.
### Styling
This project uses CSS-in-JS and [Emotion](https://emotion.sh/) for component styling. Refer to the [styling page](https://mineral-ui.com/styling/) for details.
## Questions
If you have read through the documentation but are still facing difficulties, we are happy to help. Please reproduce your error by forking our [Mineral UI Starter](https://codesandbox.io/s/v410y75m0) and adding the relevant code there. Then, send us a message on the Flowdock "Mineral & Styleguide" Flow or open an issue including the relevant link.
## Contributing
We welcome all contributors who abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). Please see the [Contributors Guide](./CONTRIBUTING.md) and [Developer Docs](./docs/README.md) for more details on submitting a PR, setting up a local dev environment, running tests, etc...
### How You Can Help
All of the work for this project is accomplished via pull requests and issues. You can submit a PR or issue to:
- Update components (PR)
- Update tests (PR)
- Improve documentation (PR)
- Suggest a change/improvement/feature (issue)
- Report a bug (issue)
Thank you for offering your time, expertise, and feedback. It’s greatly appreciated!
## Versioning
Until this project reaches a 1.0 milestone, minor version numbers will simply be incremented during each release. The [Changelog](./CHANGELOG.md) will continue to document the different types of updates, including any "breaking changes".
After the 1.0 milestone, this project will follow [SemVer](http://semver.org/).
## Browser Support
Mineral UI supports the latest versions of Chrome, Firefox, Safari, Edge, and Internet Explorer 11.
## Roadmap
Future plans and high priority features and enhancements can be found on the [Roadmap](https://mineral-ui.com/roadmap).
## License
This project is licensed under the Apache 2.0 License — see the [License](./LICENSE.md) file for details.