/Sexy-UI

Zero dependencies, zero setup, just plug and play UI components...

Primary LanguageTypeScript

Build fast, Scale high - just plug and play UI components


Language grade: JavaScript


Sexy-UI simplifies the first step in your production process by providing super-accessible plug and play UI components

Looking for the documentation? 📝

Each package has a super detailed description of how it's meant to be used - including a useCase file you can import into the main App.tsx as a sample implementation!

Latest version (v0)

Features 🚀

  • Multiple Styling Options
  • Super Fast Load times
  • Industry Standard Accessibility
  • Dark Mode Enabled
  • Responsive!
  • Premium Documentation

Support Sexy-UI 💖

Sincerely appreciative of anyone looking to provide code review or write issues or even provide mentoring as I build out this project

Individuals

Geller Micael

Organizations

YouGo Fullstack Mentoring Group Inked-in Technical Writing Community

Installing Sexy UI

To get started using Sexy-UI Components, install the @sexy-ui/react package and its peer dependencies:

$ yarn add @sexy-ui/react styled-components framer-motion@^5

# or

$ npm i @sexy-ui/react styled-components framer-motion@^5

Usage

To start using the components, please follow these steps:

  1. Wrap your application with the SexyProvider provided by @sexy-ui/react.
import { SexyProvider } from "@sexy-ui/react"

// Do this at the root of your application
const  App = ({ children }) => {
  return <SexyProvider>{children}</SexyProvider>
}

Optionally, you can wrap your application with the ToggleColorsProvider so you can toggle between light and dark mode within your app.

  1. Here's how to use components
import { Button } from "@sexy-ui/react"

const useCase = () => {
  return <Button>This Button just got sexier! </Button>
}

CodeSandbox Templates

Currenty Building out accessible templates for rapid usage with CodeSandbox and CodePen

Contributing

Looking to contribute? Marvelous!

Take a peek at our contributing guide to get started or join the mentoring server to get all your questions answered!

Contributors

Big Thanks to our amazing Gang of Thieves!


Geller99

💻 🚧 📖 💡 🎨

This project follows the all-contributors specifications.

License

MIT © Geller Micael