README.md

Beyond Design System

A design system for Renli

Packages

packages
@beyond-ui/shared
@beyond-ui/react
@beyond-ui/react-native
@beyond-ui/theme
@beyond-ui/system

✌ Usage

Create React App

To use Beyond UI Library in React, all you need to do is install the @beyond-ui/react package:

$ yarn add @beyond-ui/react

# or

$ npm i @beyond-ui/react

2. Now you can start importing components:

import { Button } from "@beyond-ui/react";

function App() {
  return (
        <Button>
            Hello,Welcome to Beyond Ui
        <Button>
      )
};

3. You can also define your own Theme:

import { ThemeProvider, Button } from "@beyond-ui/react";

function App() {
  return (
        <ThemeProvider theme={{
            color : {
                myCustomColor : "#0d0d0d"
            }
        }}>
            <Button bgcolor="myCustomColor">
            This Button is using a custom theme color
            </Button>
        <ThemeProvider>
      )
};

React-Native

😎 Support for React-Native is Coming Soon...

Contributing

Feel like contributing? That's awesome! We have a contributing guide to help guide you.

License

License MIT © Renli