one-x-design
v2.0.0
Published
The One X Design is a wrapper around [Material UI](https://material-ui.com/) enhanced with blueprints, blended components and CI compliant themes for our applications.
Downloads
2
Readme
One X Design - React Components
The One X Design is a wrapper around Material UI enhanced with blueprints, blended components and CI compliant themes for our applications.
** Starting with v2.0.0 we use MUI v5 - so this is a BREAKING CHANGE **
Installation
Simply install the package with:
npm i one-x-design
// or
yarn add one-x-design
Please make sure that you don't have
@mui/material
installed. This packages is part of theone-x-design
package and is fully exported from there.
Icons
As default icons we use Material Icons from Google. They are already converted into React components in the Material UI Icon Library. Image files and the corresponding icon font files can also be found here.
It is strongly recommended to use Material UI Icons
.
For custom icons or Haufe product identifiers you can import them into this repository.
Development / Contribution
To install and contribute to this project you need a local installation of Node.js and Yarn v1.
Clone this repository and install all necessary dependencies. As we are using yarn please type this command in your projects root folder to get started locally:
yarn && yarn start
And you are ready to create and style some awesome components!!! :rocket:
Support
To get direct support please talk to Jan Rembold, Dominikus Weiger or any other maintainer of this project.