Streamline the Laravel SaaS Starter Kit - Launch Your Next SaaS Today

Documentation

Everything you need to install, configure, and ship Turbine UI in production.

Quick Start

Install Turbine UI Core:

composer require brandymedia/turbine-ui-core

Then visit the Components page to browse examples and copy component tags.

Requirements

  • Laravel 12+
  • PHP 8.2+
  • Tailwind CSS 3+
  • Blade-based Laravel app

Tailwind Setup

Add Turbine UI view paths to your Tailwind content array:

export default {
content: [
'./resources/views/**/*.blade.php',
'./vendor/brandymedia/turbine-ui-core/**/*.php',
],
plugins: [require('@tailwindcss/forms')],
};

Rebuild assets after changes: npm run dev or npm run build.

JavaScript

Components like dropdowns, dismissibles, and theme switcher interactions require Turbine UI JS.

Publish Turbine JS assets:

php artisan vendor:publish --tag=turbine-ui-js --force

Include the Blade directive in your layout head:

@turbineUI

If JS behavior looks stale after package updates, republish and hard refresh your browser.

Button API

Canonical usage: use href for navigation. Use link only for link-style visual treatment.

Navigation button (anchor):

<x-t-button href="/components" variant="brand">
Browse Components
</x-t-button>

Link-style button appearance (style mode):

<x-t-button link variant="brand">
Text-style action
</x-t-button>

If a button should navigate, always set href. Do not use link as a URL prop.

Themes and Variants

Set the active theme in .env:

TURBINE_UI_THEME=kinetic

Publish themes for local customization:

php artisan vendor:publish --tag=turbine-ui-themes

Create custom variants:

php artisan turbine:create-variant

Use your custom variant with variant="your-variant" on any Turbine component.

Local Package Development

This project supports local in-tandem development via a Composer path repository (packages/*/*).

When using your local turbine-ui-core package:

  • Update package source code in your local package directory.
  • Republish JS/theme assets after relevant changes.
  • Rebuild frontend assets if Tailwind-scanned files changed.
php artisan vendor:publish --tag=turbine-ui-js --force
php artisan vendor:publish --tag=turbine-ui-themes --force

Component Docs

Browse all component docs, examples, and attributes on the Components page .