https://github.com/enipx/oreo-ui
Cross-platform UI components library built for React and React Native ⚡️
https://github.com/enipx/oreo-ui
oreo oreo-ui react react-native reactjs ui-components uikit
Last synced: 12 months ago
JSON representation
Cross-platform UI components library built for React and React Native ⚡️
- Host: GitHub
- URL: https://github.com/enipx/oreo-ui
- Owner: enipx
- License: mit
- Created: 2023-01-01T16:54:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-24T06:42:15.000Z (over 2 years ago)
- Last Synced: 2024-04-26T03:22:53.293Z (about 2 years ago)
- Topics: oreo, oreo-ui, react, react-native, reactjs, ui-components, uikit
- Language: TypeScript
- Homepage: https://oreo-ui.com/
- Size: 2.33 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Oreo UI
Oreo is a cross-platform UI components library built for React and React Native designed to reduce the constraint faced when building products that span across both native and web platforms.
## Features
- Components & Styling: It includes a wide range of pre-built components, including `buttons`, `modals`, and more, fully customizable and offer a range of configuration options, making it easy to tailor them to your specific needs.
- Flexibility: You can effortlessly compose UI components of your ideal choice to create a seamless user experience.
- Dark mode: All components support dark mode.
## Installation
Install dependencies:
Web
```sh
$ yarn add @oreo-ui/web styled-components
# or
$ npm i @oreo-ui/web styled-components
```
Native
```sh
$ yarn add @oreo-ui/native @oreo-ui/core styled-components react-native-svg react-native-safe-area-context
# or
$ npm i @oreo-ui/native @oreo-ui/core styled-components react-native-svg react-native-safe-area-context
```
## Usage
Once you have installed the dependencies, the next step is to wrap your application root component with the `OreoProvider`.
```jsx
import { OreoProvider } from "@oreo-ui/web" | "@oreo-ui/native"
export default function App() {
return {children}
}
```
Great! You're all set. You can now use Oreo throughout your application.
```jsx
import { Button } from "@oreo-ui/web" | "@oreo-ui/native"
function Example() {
return
}
```
Full documentation available [here](https://oreo-ui.com/)
## Todo
- [ ] improve documentation (majorly to accommodate native users properly)
- [ ] write test
- [ ] enhance UI and accessibility
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT ©