Skip to content

ImAvafe/OnyxUI

Repository files navigation

OnyxUI

Quick, quality UI components for Fusion

Build Status License


Install 📦

Features ✨

  • Dozens of fully-typed prebuilt components 🧩
  • Comprehensive theming system 🎨
  • Simplify styling UI with styling props 🖌️
  • Guarantee props with EnsureValue ✅

Documentation 📄

None as of yet. I'll work on Moonwave documentation in a future update. Sorry! Components are fully typed however, so props will autocomplete.

In alpha ⚠️

OnyxUI is not finished. I make no guarantees on the stability or consistency of the API and will introduce breaking updates as it evolves. If that doesn't deter you, get ready to enjoy how easy UI can be. ✨

Ideals ✒️

OnyxUI should provide a beautiful, simple and flexible components toolset for developers to integrate into their games and applications.

It should follow Roblox Fusion's way of doing things, while innovating upon areas as necessary.

  • Component props should be consistent: Color for a Button should mean the same as Color does for a Badge.

  • Props should be inherited across components: Button should support the props from BaseButton, Frame and GuiObject.

  • Engine-provided properties should be supported: Size, AutomaticSize, etc are useful everywhere, and should be supported everywhere.

  • Theming should be both easy and comprehensive, letting the developer choose how much, or how little they need to customize.

  • OnyxUI should enhance the developer experience, while remaining optional: use EnsureValue, Colors and styling props, or don't. It's up to you.

By Avafe