mineral-ui
Advanced tools
NOTE: We’re just getting started. While we appreciate any feedback, we’re not yet ready to accept public contributions.
A design system and React component library for the web that lets you quickly build high-quality, accessible apps. Created by CA Technologies.
Install the Mineral UI package.
npm install --save mineral-ui
or
yarn add mineral-ui
Then install any missing peer dependencies reported by npm or yarn.
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 guidelines.
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 Seleted 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.
This project uses CSS-in-JS and Glamorous for styling components. Refer to the styling page for details.
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...
All of the work for this project is accomplished via pull requests and issues. You can submit a PR or issue to:
Thank you for offering your time, expertise, and feedback. It’s greatly appreciated!
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.
Mineral UI supports the latest versions of Chrome, Firefox, Safari, Edge, and Internet Explorer 11.
Future plans and high priority features and enhancements can be found on the Roadmap.
This project is licensed under the Apache 2.0 License — see the License file for details.
0.27.0 (2018-04-13)
element prop from being passed down (74a3869)background & color props (98f06ef)Select_color_text to Select_color (also applies to TextArea & TextInput), SelectIcon_fill to SelectIcon_color (also applies to TextInput)MenuItem_color_text to MenuItem_color, MenuItemIcon_fill to MenuItemIcon_color, MenuItemSecondaryText_color_text to MenuItemSecondaryText_colorFormFieldCaption_color_text to FormFieldCaption_color, FormFieldLabel_color_text to FormFieldLabel_color, FormFieldSecondaryText_color_text to FormFieldSecondaryText_color, FormFieldSecondaryText_color_text_required to FormFieldSecondaryText_color_required, FormFieldsetLegend_color_text to FormFieldsetLegend_colorCheckboxText_color_text to CheckboxText_color (same applies to Radio)Button_borderColor_focus; rename theme variables: Button_color_text to Button_color, Button_color_text_minimal to Button_color_minimal, Button_color_text_primary to Button_color_primarybackground and color prop types. Instead, import colors and reference from there (e.g. colors.red_60).theme.color_gray_60color_caption, backgroundColor_link_focus; rename: backgroundColor_disabled to backgroundColor_input_disabled, backgroundColor_input to input_backgroundColor, backgroundColor_[variant]_muted to well_backgroundColor_[variant], backgroundColor_[variant]_activeMuted to backgroundColor_[variant]_active, backgroundColor_[variant]_[state] to backgroundColor_[variant]Primary_[state], borderColor_[state] to borderColor_theme_[state], borderColor_[variant]_muted to well_borderColor_[variant], color_h[#] to h[#]_color, color_placeholder to placeholder_color, color_text to color, color_text_disabled to color_disabled, color_text_primary_[state] to color_theme_[state], color_text_onprimary to color_primary, color_text_[variant]_[state] to color_[variant]_[state], fontSize_h[#] to h[#]_fontSize, fontWeight_h[#] to h[#]_fontWeight, shadow_[#] to boxShadow_[#]lime, orange, and yellow<a name="0.26.0"></a>
FAQs
Mineral UI component library
The npm package mineral-ui receives a total of 836 weekly downloads. As such, mineral-ui popularity was classified as not popular.
We found that mineral-ui demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.