This repository contains detailed documentation for Flux UI, a robust UI component library designed for Laravel Livewire applications. It includes comprehensive guides for all components, installation instructions, theming, customization options, and best practices.
The documentation covers:
- 35+ UI components with examples and usage patterns
- Installation and upgrade guides
- Theming and dark mode implementation
- Core design principles and component patterns
- Customization options
Whether you're new to Flux UI or an experienced user, this documentation provides valuable resources to help you build beautiful, functional interfaces with the Flux UI library.
Flux UI is a hand-crafted UI component library that provides a set of components designed to work seamlessly with Laravel Livewire. This documentation repository serves as a complete reference for working with Flux UI components and features.
The documentation is organized into the following sections:
Detailed documentation for each Flux UI component:
- Layout Components: Header, Sidebar, etc.
- Form Components: Input, Checkbox, Radio, Select, Switch, Textarea, Autocomplete
- Navigation Components: Breadcrumbs, Navbar, Pagination
- Display Components: Accordion, Avatar, Badge, Brand, Button, Card, Icon, Tooltip
- Feedback Components: Callout, Modal, Toast
- Data Components: Table, Tabs, Calendar, Chart, Dropdown
- Typography Components: Heading, Text, Editor, Separator
- Other Components: Profile
Each component documentation includes:
- Basic usage examples
- Available variants and options
- Props reference
- Code examples
- Installation - Setting up Flux UI in your Laravel project
- Upgrade Guide - Instructions for upgrading between versions
- Design Principles - The core design philosophy of Flux UI
- Component Patterns - Common patterns used across components
- Theming - Customizing colors and appearance
- Dark Mode - Working with dark mode
- Customization - Customizing components
- Help - Getting assistance with Flux UI
For the official Flux UI documentation, please visit fluxui.dev.
Flux UI is a commercial product. This documentation repository is provided for reference only and should be used in accordance with the Flux UI license terms.
This is an unofficial documentation repository. For official contributions to Flux UI, please refer to the official Flux UI GitHub repository.