# mineral-ui > Mineral UI component library Latest version **0.58.0** (published 2019-03-30) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install mineral-ui pnpm add mineral-ui yarn add mineral-ui bun add mineral-ui ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: esm support; no vulnerabilities. Warnings: low downloads; no types; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.58.0 | | Published | 2019-03-30 | | First published | 2017-09-05 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | ESM + CommonJS | | Dependencies | 15 | | Unpacked size | 1.3 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 555 | | Author | CA Technologies | | Maintainers | brentertz, coldpour, kylegach, victoriavasys | ## Links - npm: https://www.npmjs.com/package/mineral-ui - Repository: https://github.com/mineral-ui/mineral-ui - Homepage: http://mineral-ui.com - Issues: https://github.com/mineral-ui/mineral-ui/issues - npm.io page: https://npm.io/package/mineral-ui ## Dependencies (15) - [exenv](https://npm.io/package/exenv.md) 1.2.2 - [no-scroll](https://npm.io/package/no-scroll.md) 2.1.1 - [recompose](https://npm.io/package/recompose.md) 0.30.0 - [prop-types](https://npm.io/package/prop-types.md) ^15.5.7 - [memoize-one](https://npm.io/package/memoize-one.md) 4.0.3 - [lodash.range](https://npm.io/package/lodash.range.md) 3.2.0 - [react-popper](https://npm.io/package/react-popper.md) 1.3.3 - [lodash.debounce](https://npm.io/package/lodash.debounce.md) 4.0.8 - [focus-trap-react](https://npm.io/package/focus-trap-react.md) 3.1.2 - [fontfaceobserver](https://npm.io/package/fontfaceobserver.md) 2.0.13 - [mineral-ui-tokens](https://npm.io/package/mineral-ui-tokens.md) 0.4.0 - [react-fast-compare](https://npm.io/package/react-fast-compare.md) 2.0.4 - [react-transition-group](https://npm.io/package/react-transition-group.md) 2.3.0 - [hoist-non-react-statics](https://npm.io/package/hoist-non-react-statics.md) 3.2.1 - [scroll-into-view-if-needed](https://npm.io/package/scroll-into-view-if-needed.md) 2.2.20 ## Recent versions - 0.58.0 (latest) — 2019-03-30 - 0.57.0-next.1 (next) — 2019-02-05 - 0.57.0 — 2019-03-14 - 0.57.0-next.0 — 2019-01-28 - 0.56.0 — 2019-01-21 - 0.55.0 — 2018-12-03 - 0.54.0 — 2018-11-26 - 0.53.0 — 2018-11-21 - 0.52.0 — 2018-11-19 - 0.51.0 — 2018-11-15 - 0.50.0 — 2018-11-14 - 0.49.0 — 2018-11-05 - 0.49.0-789-button-group.0 — 2018-10-25 - 0.48.0 — 2018-10-17 - 0.47.0 — 2018-09-27 - … 54 more at https://npm.io/package/mineral-ui/versions ## README [![build status](https://travis-ci.com/mineral-ui/mineral-ui.svg?branch=master)](https://travis-ci.com/mineral-ui/mineral-ui) [![dependency status](https://david-dm.org/mineral-ui/mineral-ui.svg)](https://david-dm.org/mineral-ui/mineral-ui) [![managed with Waffle](https://img.shields.io/badge/managed_with-Waffle-72b2e4.svg)](https://waffle.io/mineral-ui/mineral-ui) [![Commitizen friendly](https://img.shields.io/badge/Commitizen-friendly-brightgreen.svg?style=flat)](https://github.com/commitizen/cz-cli) [![code style Prettier](https://img.shields.io/badge/code_style-Prettier-ff69b4.svg)](https://github.com/prettier/prettier) # [Mineral UI](https://mineral-ui.com/) A design system and [React](https://reactjs.org/) component library for the web that lets you quickly build high-quality, accessible apps. Created by [CA Technologies](http://ca.com). ## 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 ( ); } 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. --- _Source: https://npm.io/package/mineral-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._