invokable/google-sheets-project/fluxui-development

Flux UI Development

Documentation

Use search-docs for detailed Flux UI patterns and documentation.

Basic Usage

This project uses the free edition of Flux UI, which includes all free components and variants but not Pro components.

Flux UI is a component library for Livewire built with Tailwind CSS. It provides components that are easy to use and customize.

Use Flux UI components when available. Fall back to standard Blade components when no Flux component exists for your needs.

<!-- Basic Button -->

<flux:button variant="primary">Click me</flux:button>

Available Components (Free Edition)

Available: avatar, badge, brand, breadcrumbs, button, callout, card, checkbox, dropdown, field, heading, icon, input, modal, navbar, otp-input, pagination, profile, progress, radio, select, separator, skeleton, switch, table, text, textarea, toast, tooltip

Icons

Flux includes Heroicons as its default icon set. Search for exact icon names on the Heroicons site - do not guess or invent icon names.

<!-- Icon Button -->

<flux:button icon="arrow-down-tray">Export</flux:button>

For icons not available in Heroicons, use Lucide. Import the icons you need with the Artisan command:

php artisan flux:icon crown grip-vertical github

Common Patterns

Form Fields

<!-- Form Field -->

<flux:field>
    <flux:label>Email</flux:label>
    <flux:input type="email" wire:model="email" />
    <flux:error name="email" />
</flux:field>

Modals

<!-- Modal -->

<flux:modal wire:model="showModal">
    <flux:heading>Title</flux:heading>
    <p>Content</p>
</flux:modal>

Verification

1. Check component renders correctly
2. Test interactive states
3. Verify mobile responsiveness

Common Pitfalls

• Trying to use Pro-only components in the free edition
• Not checking if a Flux component exists before creating custom implementations
• Forgetting to use the search-docs tool for component-specific documentation
• Not following existing project patterns for Flux usage