{"id":13394218,"url":"https://github.com/mineral-ui/mineral-ui","last_synced_at":"2026-01-12T02:27:42.607Z","repository":{"id":42249112,"uuid":"87827232","full_name":"mineral-ui/mineral-ui","owner":"mineral-ui","description":"A design system and React component library for the web brought to you by CA Technologies.","archived":false,"fork":false,"pushed_at":"2022-12-06T17:57:27.000Z","size":15082,"stargazers_count":556,"open_issues_count":63,"forks_count":48,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-05-16T13:42:22.770Z","etag":null,"topics":["accessibility","components","design-systems","mineral-ui","react"],"latest_commit_sha":null,"homepage":"http://mineral-ui.netlify.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mineral-ui.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-10T15:29:20.000Z","updated_at":"2024-04-04T07:42:42.000Z","dependencies_parsed_at":"2022-09-14T01:33:22.019Z","dependency_job_id":null,"html_url":"https://github.com/mineral-ui/mineral-ui","commit_stats":null,"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mineral-ui%2Fmineral-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mineral-ui%2Fmineral-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mineral-ui%2Fmineral-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mineral-ui%2Fmineral-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mineral-ui","download_url":"https://codeload.github.com/mineral-ui/mineral-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243465634,"owners_count":20295304,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","components","design-systems","mineral-ui","react"],"created_at":"2024-07-30T17:01:12.874Z","updated_at":"2026-01-12T02:27:42.599Z","avatar_url":"https://github.com/mineral-ui.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\n[![build status](https://travis-ci.com/mineral-ui/mineral-ui.svg?branch=master)](https://travis-ci.com/mineral-ui/mineral-ui)\n[![dependency status](https://david-dm.org/mineral-ui/mineral-ui.svg)](https://david-dm.org/mineral-ui/mineral-ui)\n[![Commitizen friendly](https://img.shields.io/badge/Commitizen-friendly-brightgreen.svg?style=flat)](https://github.com/commitizen/cz-cli)\n[![code style Prettier](https://img.shields.io/badge/code_style-Prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n\n# Mineral UI\n\n[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.\n\n\u003e [ℹ️▶️ **Please read**: Important updates regarding the status of this project](./docs/status-of-mineral-ui.md)\n\n## Project Goals\n\n- Consistent, thoughtful design\n- Accessible and inclusive\n- Performant\n- Responsive\n- Powerful and easy to develop with inside your app\n\n\n## Getting Started\n\n### Installation\n\nInstall the [Mineral UI package](https://www.npmjs.com/package/mineral-ui) and\nits dependencies.\n\n```bash\nnpm install mineral-ui emotion-theming @emotion/core @emotion/is-prop-valid @emotion/styled react react-dom\n```\n\nor\n\n```bash\nyarn add mineral-ui emotion-theming @emotion/core @emotion/is-prop-valid @emotion/styled react react-dom\n```\n\n\n### Usage\n\n```jsx\nimport React from 'react';\nimport { render } from 'react-dom';\nimport Button from 'mineral-ui/Button';\nimport { ThemeProvider } from 'mineral-ui/themes';\n\nfunction App() {\n  return (\n    \u003cThemeProvider\u003e\n      \u003cButton\u003e\n        Hello World\n      \u003c/Button\u003e\n    \u003c/ThemeProvider\u003e\n  );\n}\n\nrender(\u003cApp /\u003e, document.getElementById('app'));\n```\n\n\u003e 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.\n\n\u003e Also, please see our [import syntax guide](https://mineral-ui.com/import-syntax).\n\n\n### Open Sans Font\n\nMineral 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 `\u003chead\u003e` of your HTML document.\n\n```html\n\u003clink href=\"https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i,700,700i,800,800i\" rel=\"stylesheet\"\u003e\n```\n\nFor 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.\n\n\n### Styling\n\nThis 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.\n\n## Questions\n\nIf 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 \u0026 Styleguide\" Flow or open an issue including the relevant link.\n\n## Contributing\n\nWe 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...\n\n\n### How You Can Help\n\nAll of the work for this project is accomplished via pull requests and issues. You can submit a PR or issue to:\n\n- Update components (PR)\n- Update tests (PR)\n- Improve documentation (PR)\n- Suggest a change/improvement/feature (issue)\n- Report a bug (issue)\n\nThank you for offering your time, expertise, and feedback. It’s greatly appreciated!\n\n\n## Versioning\n\nUntil 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\".\n\nAfter the 1.0 milestone, this project will follow [SemVer](http://semver.org/).\n\n\n## Browser Support\n\nMineral UI supports the latest versions of Chrome, Firefox, Safari, Edge, and Internet Explorer 11.\n\n\n## Roadmap\n\nFuture plans and high priority features and enhancements can be found on the [Roadmap](https://mineral-ui.com/roadmap).\n\n\n## License\n\nThis project is licensed under the Apache 2.0 License — see the [License](./LICENSE.md) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmineral-ui%2Fmineral-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmineral-ui%2Fmineral-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmineral-ui%2Fmineral-ui/lists"}