livewire / flux
The official UI component library for Livewire.
Installs: 158
Dependents: 0
Suggesters: 0
Security: 0
Stars: 134
Watchers: 9
Forks: 8
Open Issues: 0
Language:Blade
Requires
- php: ^8.1
- illuminate/console: ^10.0|^11.0
- illuminate/support: ^10.0|^11.0
- illuminate/view: ^10.0|^11.0
- laravel/prompts: ^0.1.24
- livewire/livewire: ^3.5
- symfony/console: ^6.0|^7.0
This package is auto-updated.
Last update: 2024-09-19 20:09:17 UTC
README
Flux is the official UI component library for Livewire.
You can view the components in action at https://fluxui.dev.
Installation
Run the following command from your project's root directory:
composer require livewire/flux:v1.0.0-beta.5 --prefer-dist
Flux has built-in scripts and styles that are required to use the components. Add the following to your app template's head and body tags:
<head> ... @fluxStyles </head> <body> ... @fluxScripts </body>
Flux uses Tailwind CSS for its styles.
To get started quickly, you can include the Tailwind Play CDN in your head tag:
<head> ... <script src="//cdn.tailwindcss.com"></script> @fluxStyles </head>
Or, for a more robust setup, you can include Flux's Blade files as part of your build in your Tailwind config's content array:
module.exports = { content: [ ..., "./vendor/livewire/flux-pro/stubs/**/*.blade.php", "./vendor/livewire/flux/stubs/**/*.blade.php", ], ... }
What's included?
The following components are included in the livewire/flux package:
The rest of the Flux components are part of the paid (Pro) tier of Flux.
Purchase a "Pro" license key here: https://fluxui.dev/pricing