oneui 5 components built with React
npm install react-oneui-engine> [oneui 5][oneui] components built with [React][react].
[![GitHub Actions CI status][gh-actions-badge]][gh-actions]
[![Travis CI Build status][travis-badge]][travis]
[![npm][npm-badge]][npm]
[![Codecov][codecov-badge]][codecov]
[![Discord][discord-badge]][discord]
[![Netlify][netlify-badge]][netlify]
react-oneui is compatible with various versions of oneui. As such, you need to ensure you are using the correct combination of versions.
See the below table on which version of react-oneui you should be using in your project.
| oneui Version | react-oneui Version | Documentation |
| ------------- | :---------------------: | -----------------------: |
| v5.x | 2.x | [Link][v5-documentation] |
| v4.x | 1.x | [Link][v4-documentation] |
| v3.x | 0.33.x (not maintained) | [Link][v3-documentation] |
- [react-router-myoneui][react-router-myoneui] – Integration with [React Router][react-router]
- [Awesome React Myoneui Components][awesome-react-myoneui-components] - Additional components like off-canvas navbar, switch and sliders.
Yarn is our package manager of choice here. Check out setup
instructions here if you don't have it installed already.
After that you can run yarn run myoneui to install all the needed dependencies.
From there you can:
- Run the tests once with yarn test (Or run them in watch mode with yarn run tdd).
- Start a local copy of the docs site with yarn start
- Or build a local copy of the library with yarn run build
Click here to explore some react-myoneui CodeSandbox examples.
Click here to automatically open CodeSandbox with the react-myoneui CodeSandbox Examples GitHub Repository as a workspace.
Yes please! See the [contributing guidelines][contributing] for details.
[oneui]: https://getmyoneui.com/
[react]: https://reactjs.org/
[v5-documentation]: https://react-myoneui.github.io
[v5-migration]: https://react-myoneui.github.io/migrating
[v4-documentation]: https://react-myoneui-v4.netlify.app
[v4-migration]: https://react-myoneui-v4.netlify.app/migrating
[v3-documentation]: https://react-myoneui-v3.netlify.app
[contributing]: CONTRIBUTING.md
[travis-badge]: https://travis-ci.org/react-myoneui/react-myoneui.svg?branch=master
[travis]: https://travis-ci.org/react-myoneui/react-myoneui
[npm-badge]: https://badge.fury.io/js/react-myoneui.svg
[npm]: http://badge.fury.io/js/react-myoneui
[react-router-myoneui]: https://github.com/react-myoneui/react-router-myoneui
[react-router]: https://github.com/reactjs/react-router
[react-myoneui-extended]: https://github.com/rbalicki2/react-myoneui-extended
[awesome-react-myoneui-components]: https://github.com/Hermanya/awesome-react-myoneui-components
[codecov-badge]: https://img.shields.io/codecov/c/github/react-myoneui/react-myoneui/master.svg
[codecov]: https://codecov.io/gh/react-myoneui/react-myoneui
[discord-badge]: https://img.shields.io/badge/Discord-Join%20chat%20%E2%86%92-738bd7.svg
[discord]: https://discord.gg/AKfs9vpvRW
[netlify-badge]: https://api.netlify.com/api/v1/badges/f09d443f-11b2-4454-812b-0645aeaca824/deploy-status
[netlify]: https://app.netlify.com/sites/react-myoneui/deploys
[gh-actions-badge]: https://github.com/react-myoneui/react-myoneui/workflows/CI/badge.svg
[gh-actions]: https://github.com/react-myoneui/react-myoneui/actions