Skip to content
A design system and React component library for the web brought to you by CA Technologies.
Branch: master
Clone or download
brentertz docs(all): Misc updates
* Remove Waffle badge from Readme
* Replace Waffle links with GitHub Project links
* Update component-status and roadmap pages
Latest commit 7e60592 Apr 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore(documentation): Remove "not accepting contributions" message Jul 17, 2018
__mocks__ chore(license): Remove license header from individual source files Mar 13, 2018
docs docs(readme,migration): Update readme and add migration guide Mar 14, 2019
flow-typed/npm feat(all): Emotion 10 update and other API changes Mar 14, 2019
packages build(packages): Ensure sub-package builds respect babel config Feb 13, 2019
scripts build(library): Ignore spec and template files during build Jan 24, 2019
src docs(all): Misc updates Apr 4, 2019
utils test(all): Update snapshots Mar 14, 2019
.eslintignore refactor(mineral-ui-tokens): Misc updates May 7, 2018
.eslintrc feat(all): Emotion 10 update and other API changes Mar 14, 2019
.flowconfig feat(all): Emotion 10 update and other API changes Mar 14, 2019
.gitignore build(misc): See full message for details May 1, 2018
.happo.js chore(dependencies): Update Happo Jan 18, 2019
.huskyrc chore(dependencies): Update dependencies Dec 3, 2018
.npmrc build(node,npm): Update to node 8.1.4 and npm 5.0.3 Jul 12, 2017
.nvmrc build(node): Bump node version to 10.15.0 Jan 24, 2019
.prettierrc chore(prettier): Format files Dec 3, 2018
.travis.yml test(all): Update tests, configuration, and utils Mar 14, 2019
.vcmrc chore(dependencies): Update dependencies Aug 14, 2017
CHANGELOG.md docs(changelog): 0.58.0 Mar 30, 2019
CODE_OF_CONDUCT.md docs(repo): Update repo docs (#5) Apr 27, 2017
CONTRIBUTING.md docs(contributing): Fix RFC link Jan 25, 2019
LICENSE.md chore(license): Update license to Apache2 (#7) Apr 28, 2017
README.md docs(all): Misc updates Apr 4, 2019
babel.config.js test(all): Update tests, configuration, and utils Mar 14, 2019
jest.config.js test(all): Update tests, configuration, and utils Mar 14, 2019
package.json chore(release): 0.58.0 Mar 30, 2019
webpack.config.js refactor(website): Updates per component refactoring Nov 14, 2018

README.md

build status dependency status Commitizen friendly code style Prettier

Mineral UI

A design system and React component library for the web that lets you quickly build high-quality, accessible apps. Created by CA Technologies.

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 and its dependencies.

npm install mineral-ui emotion-theming @emotion/core @emotion/is-prop-valid @emotion/styled react react-dom

or

yarn add mineral-ui emotion-theming @emotion/core @emotion/is-prop-valid @emotion/styled react react-dom

Usage

import React from 'react';
import { render } from 'react-dom';
import Button from 'mineral-ui/Button';
import { ThemeProvider } from 'mineral-ui/themes';

function App() {
  return (
    <ThemeProvider>
      <Button>
        Hello World
      </Button>
    </ThemeProvider>
  );
}

render(<App />, document.getElementById('app'));

Your app must be wrapped in a ThemeProvider at its root in order for the styles to apply correctly.

Also, please see our import syntax guide.

Open Sans Font

Mineral UI was designed around 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 <head> of your HTML document.

<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i,700,700i,800,800i" rel="stylesheet">

For more options loading this font from Google, check out the Selected Family popup, in the specimen. 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 for component styling. Refer to the styling page 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 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. Please see the Contributors Guide and Developer Docs 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 will continue to document the different types of updates, including any "breaking changes".

After the 1.0 milestone, this project will follow SemVer.

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.

License

This project is licensed under the Apache 2.0 License — see the License file for details.

You can’t perform that action at this time.