{"id":"abovefolks/rbx-ui","name":"rbx-ui","scope":"abovefolks","platform":"roblox","description":"A comprehensive collection of reusable UI components for Roblox games built with Vide","version":"0.1.2","latest":"0.1.2","versions":["0.1.1","0.1.2"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":false,"dependencies":{"centau/vide":{"version":"^0.4.0","alias":"Vide"}},"integrity":"603138526d5a381de17bbc0d60e843fde62aababd89f6767a0a3606d4ba9b0f3","likes":0,"downloads":0,"install":"forest install abovefolks/rbx-ui","url":"https://forest.dev/p/roblox/abovefolks/rbx-ui","files":"https://api.forest.dev/ai/package/roblox/abovefolks/rbx-ui/files","readme":"# RBX UI\n\nA comprehensive collection of reusable UI components for Roblox games built with [Vide](https://github.com/centau/vide). This library provides a set of production-ready components designed to streamline UI development in Roblox.\n\n## Features\n\n- **Component-Based Architecture**: Modular, reusable UI components\n- **Vide Integration**: Built with Vide for reactive and declarative UI\n- **Theming Support**: Centralized theme management with customizable styling\n- **Animation Support**: Built-in motion and transition components\n- **Type-Safe**: Developed in Luau with full type annotations\n- **Developer-Friendly**: Simple APIs with comprehensive component library\n\n## Available Components\n\n| Component       | Description                                              |\n| --------------- | -------------------------------------------------------- |\n| **Button**      | Standard clickable button with various states and styles |\n| **IconButton**  | Compact button component displaying an icon              |\n| **Card**        | Container component for organizing content               |\n| **Panel**       | Flexible panel component for UI layouts                  |\n| **Modal**       | Dialog/modal window for overlaying content               |\n| **Toggle**      | Switch component for boolean states                      |\n| **Slider**      | Range input component for numeric values                 |\n| **ProgressBar** | Visual progress indicator                                |\n| **Motion**      | Animation and motion utilities                           |\n| **Theme**       | Theme system for consistent styling across components    |\n\n## Installation\n\nThis project uses [Wally](https://wally.run/) for dependency management.\n\n```toml\n[dependencies]\nRbxUI = \"abovefolks/rbx-ui@0.1.0\"\n```\n\nRun `wally install` to download dependencies.\n\n## Getting Started\n\n### Building the Place\n\nTo build the Roblox place from scratch:\n\n```bash\nrojo build -o \"RBX UI.rbxlx\"\n```\n\n### Serving in Development\n\nOpen `RBX UI.rbxlx` in Roblox Studio, then start the Rojo server for live sync:\n\n```bash\nrojo serve\n```\n\nFor detailed information, see [Rojo documentation](https://rojo.space/docs).\n\n## Usage\n\n### Basic Component Example\n\n```luau\nlocal UI = require(game.ReplicatedStorage.Components.UI)\n\nlocal Button = UI.Button({\n    Label = \"Click Me\",\n    OnClick = function()\n        print(\"Button clicked!\")\n    end\n})\n```\n\n### Theme Customization\n\nUse the Theme component to manage and apply custom styling:\n\n```luau\nlocal Theme = require(game.ReplicatedStorage.Components.UI.Theme)\n\nTheme:SetColor(\"Primary\", Color3.fromRGB(255, 100, 50))\n```\n\n## Project Structure\n\n```\nRBX UI/\n├── Components/\n│   └── UI/                    # Reusable UI components\n│       ├── Button.luau\n│       ├── Card.luau\n│       ├── IconButton.luau\n│       ├── Modal.luau\n│       ├── Motion.luau\n│       ├── Panel.luau\n│       ├── ProgressBar.luau\n│       ├── Slider.luau\n│       ├── Theme.luau\n│       ├── Toggle.luau\n│       └── init.luau\n├── Packages/                  # Wally dependencies\n├── src/\n│   ├── client/               # Client-side scripts\n│   ├── server/               # Server-side scripts\n│   └── shared/               # Shared utilities\n└── default.project.json      # Rojo project configuration\n```\n\n## Dependencies\n\n- [Vide](https://github.com/centau/vide) - Reactive UI framework\n- [Promise](https://github.com/evaera/promise) - Async/await utilities\n- [Networker](https://github.com/leifstout/networker) - Network communication\n\n## Development\n\n### Requirements\n\n- [Rojo](https://github.com/rojo-rbx/rojo) 7.6.1+\n- [Wally](https://wally.run/) - Package manager\n- [Roblox Studio](https://www.roblox.com/create)\n\n### Setup\n\n1. Clone the repository\n2. Install dependencies: `wally install`\n3. Build the place: `rojo build -o \"RBX UI.rbxlx\"`\n4. Open the generated file in Roblox Studio\n5. Start the development server: `rojo serve`\n\n## Contributing\n\nContributions are welcome! Please feel free to submit issues or pull requests to improve the component library.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Support\n\nFor issues, questions, or suggestions, please open an issue on the repository.\n\n---\n\nBuilt with ❤️ for the Roblox developer community\n","readmeTruncated":false}