Getting Started
TimelyUI is distributed as a set of Blade + Livewire components, Alpine interactions, and Tailwind-first design tokens. It plays nicely with new and existing Laravel apps.
Requirements
- Laravel 11+
- Livewire 3+
- PHP 8.2+
- Node 18+ / Bun / PNPM (for building assets)
Folder Conventions
Install
-
Install dependencies
-
Tailwind config
-
Add TimelyUI styles
-
Enable Livewire (Blade layout example)
Project Structure
TimelyUI ships a component-first structure. Keep UI pieces co-located:
Suggested naming conventions:
<x-timelyui-button/>— atoms<x-timelyui-card/>— molecules<x-timelyui-table />— organisms<livewire:timelyui.modal />— interactive patterns
Theming & Dark Mode
Use Tailwind's extend.colors and CSS variables for easy brand skins. Dark mode is class-based.
Color Tokens
Dark Toggle (Alpine)
Core Components
Production-ready, accessible, keyboard-friendly. Below are representative samples. Copy & adapt.
Buttons
Card
Use cards to group content.
Stats
Table
Modal
Create Project
Tabs
Table Filters (Alpine) — long expression safe:
Charts
Patterns & Recipes
Form + Validation
Table Filters (Alpine)
Accessibility
- Keyboard reachable menus and modals (
Tab,Escsupport). - Sufficient color contrast in both light and dark themes.
- Semantic HTML:
<button>for actions,aria-*where needed. - Focus outlines preserved for interactive elements.
Performance
- Use
deferfor heavy scripts; load charts only where needed. - Tree-shake with Vite; split vendor bundles.
- Server-side pagination for large tables (Livewire paginate).
- Prefer CSS utilities over runtime JS for transitions.
Deployment
- Build:
vite build - Cache:
php artisan config:cache route:cache view:cache - Queues:
php artisan queue:work --daemon(Supervisor on VPS) - Assets: Use CDN or versioned
mix-manifest.json/vitebuild.
FAQ
Does TimelyUI require Livewire?
Most interactive patterns assume Livewire or Alpine. Pure Blade/Alpine is possible for static pieces.
Can I use it with Inertia or Vue?
Yes, the styling and HTML work anywhere. Replace Livewire interactions with your framework’s bindings.
License?
Commercial license for use in unlimited projects you build. Resale of the kit as-is is not permitted.
Changelog
- 1.0.0 — Initial public docs, core components, patterns, dark mode, charts demo.