README

A shadcn-like CLI for Laravel Livewire components.

PHP-UI allows you to scaffold beautifully designed, accessible, and customizable components for your Laravel Livewire applications. It detects your Tailwind setup (v3 or v4) and handles dependencies automatically.

Installation

You can install the package via composer globally to use it in any project:

composer global require jiordiviera/php-ui

Alternatively, you can install it as a dev dependency in a specific project:

composer require --dev jiordiviera/php-ui

Usage

1. Initialize

Run the init command to set up the configuration for your project.

php-ui init

2. List Available Components

See all components you can add to your project.

php-ui list

3. Add Components

Use the add command to scaffold a new component.

php-ui add <component-name>

Options:

--force or -f: Overwrite existing files without asking.
--url or -u: Install a component from a direct URL.
--registry or -r: Use a custom registry URL.
--repo: Install from a GitHub repository.

4. Install from Remote Sources

PHP-UI supports installing components from remote sources, similar to shadcn/ui.

From a direct URL:

php-ui add --url https://example.com/my-button.blade.php.stub

From a GitHub repository:

php-ui add button --repo owner/repo
php-ui add button --repo owner/repo@branch

From a custom registry:

php-ui add button --registry https://example.com/registry.json
php-ui add --registry https://example.com/registry.json  # Interactive search

Available Components (25+)

Base & Form

button: Versatile button with variants and sizes.
input: Form field with label, icons, and error handling.
toggle: Accessible switch for boolean values.
range-slider: Single or double handle numeric slider.
file-upload: Zone with drag-and-drop and progress bar.

Navigation & Layout

breadcrumbs: Navigation trail for nested pages.
tabs: Tabbed interface for content switching.
modal: Accessible dialog with transitions.
drawer: Side panel sliding from edges.
accordion: Expandable content panels.

Feedback & Status

alert: Contextual messages for user actions.
badge: Small status indicators.
toast: Global notification system.
tooltip: Hover information popups.
progress-bar: Visual progress indicator.
progress-steps: Horizontal process tracker.
skeleton: Loading state placeholders.

Data & Visualization

data-table: Advanced table with search, sort, and pagination.
stat-card: Metrics display with trends and icons.
timeline: Chronological event display.
rating: Star rating with half-star support.

Utilities

avatar: Profile image with fallback initials and status.
avatar-group: Stacked user avatars.
command-palette: Global Spotlight-style search interface.
kbd: Keyboard key indicators.
code-snippet: Code display with copy functionality.
empty-state: Placeholder for empty collections.

Creating a Custom Registry

You can host your own component registry. Create a registry.json file:

{
  "name": "My Custom Components",
  "baseUrl": "https://raw.githubusercontent.com/username/my-components/main",
  "components": {
    "custom-button": {
      "description": "My custom button component",
      "dependencies": {
        "composer": ["mallardduck/blade-lucide-icons"],
        "npm": []
      },
      "css_vars": {},
      "js_stubs": []
    }
  }
}

Then host your stubs in a stubs/ folder alongside the registry.

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.

jiordiviera / php-ui

Maintainers

Details