tomevault-io Tablar — Installation
When to use this skill
- User runs
composer require takielias/tablarand asks how to finish setup. - User wants to switch layout (
horizontal,condensed,combined, etc.). - User upgrades tablar across major versions.
- User reports broken styling, missing routes, or
Route [profile] not definedafter install.
Install flow
composer require takielias/tablar
php artisan tablar:install
npm install && npm run dev # or: npm run build
php artisan tablar:export-auth # publishes Breeze-style auth controllers + views
tablar:install flags:
--force— overwrite user-modified files without prompting. Without it, install will diff each destination against the stub and prompt per file.--no-credits— suppress the "Star us on GitHub" credits line.
After install completes, the command prints:
✅ Tablar installed (Laravel {N}).
Next: npm install && npm run dev
Then: php artisan tablar:export-auth
What tablar:install does
- Runs
TablarPreset::install():- Updates
package.jsondependencies (Tabler core, Vite, sass-embedded, tabler-icons). - Updates
vite.config.jsandresources/sass/tabler.scss. - Updates
resources/js/app.jsbootstrapping. - Updates
resources/views/welcome.blade.php. - Removes
node_modules/(forces a cleannpm install).
- Updates
- Runs
TablarPreset::exportConfig()— publishesconfig/tablar.php. - Calls
checkController()— Laravel 11+ only: rewritesapp/Http/Controllers/Controller.phpto extend\Illuminate\Routing\Controller. Idempotent. - Calls
patchUserModelForSoftDeletes()— addsIlluminate\Database\Eloquent\SoftDeletesimport + trait toApp\Models\User. Idempotent. Both single-lineuse HasFactory, Notifiable;and multi-lineuse HasFactory;\nuse Notifiable;patterns handled.
safeCopy() applies to every published stub: if the destination matches the stub hash → skip silently; if user-modified → prompt or honor --force.
Companion artisan commands
| Command | Purpose |
|---|---|
tablar:install |
Full install (config, packages, view bootstrap, controller patch, soft-deletes patch). |
tablar:export-auth |
Publish auth controllers, views, FormRequests (Profile/Settings/Login/Register/etc.). Run after tablar:install. |
tablar:export-config |
Re-publish config/tablar.php only. |
tablar:export-views |
Re-publish all view stubs. |
tablar:export-assets |
Re-publish SCSS/JS assets. |
tablar:export-js |
JS-only re-publish. |
tablar:export-all |
Re-publish everything (views + assets + JS + auth). |
tablar:update |
Refresh package deps + assets without re-running scaffolding. |
tablar:doctor |
One-shot environment snapshot for debugging install issues. |
Layout selection
config('tablar.layout') — default 'horizontal'.
Other supported values resolve view partials at resources/views/layouts/{layout}.blade.php (verify by reading resources/views/page.blade.php line 16 — @includeIf('tablar::layouts.'. config('tablar.layout'))).
Auxiliary keys interact with layout choice:
'layout_light_topbar'(true / false / null) —data-bs-themeon the top bar.'layout_light_sidebar'(true / false / null) —data-bs-themeon the sidebar.'layout_enable_top_header'(bool) — render top header row in sidebar layouts.
For RTL: set 'layout' => 'rtl' — master.blade.php adds dir="rtl" to <html> automatically.
Post-install patches
User model — SoftDeletes
After install:
use Illuminate\Database\Eloquent\SoftDeletes;
class User extends Authenticatable
{
use HasFactory, Notifiable, SoftDeletes;
}
Migration to add deleted_at is shipped at database/migrations/2014_10_12_100000_add_soft_deletes_to_users_table.php via tablar:export-auth.
Base Controller class (L11+)
Laravel 11+ ships streamlined app/Http/Controllers/Controller.php as abstract class Controller {} (no parent). Tablar patches it to:
abstract class Controller extends \Illuminate\Routing\Controller
{
}
Without this patch, controller traits + middleware helpers break.
Profile + Settings controllers
tablar:export-auth publishes:
app/Http/Controllers/ProfileController.php— name-only profile form (email read-only).app/Http/Controllers/SettingsController.php— appearance + password + delete-account.app/Http/Requests/{UpdateProfileRequest,UpdatePasswordRequest,DeleteAccountRequest}.php— FormRequests with named error bags (updatePassword,deleteAccount) so validation errors surface inside Tabler tabs.
Routes published to routes/auth.php under auth middleware:
GET /profile → ProfileController@show (profile)
PATCH /profile → ProfileController@update (profile.update)
GET /settings → SettingsController@show (settings)
PUT /settings/password→ SettingsController@updatePassword (settings.password)
DELETE /settings → SettingsController@destroy (settings.destroy)
Recipes
1. Fresh install (Laravel 12, no auth scaffolding yet)
laravel new myapp && cd myapp
composer require takielias/tablar
php artisan tablar:install
npm install && npm run dev
php artisan tablar:export-auth
php artisan migrate
Visit /login, /profile, /settings.
2. Adding tablar to an existing Breeze app
composer require takielias/tablar
php artisan tablar:install --force=false # prompts per file
When tablar:install prompts about Controller.php or User.php:
Controller.php— accept overwrite. The patch only addsextends \Illuminate\Routing\Controller; keeps the rest.User.php— accept. Patch is regex-based and adds SoftDeletes alongside Breeze's existing traits.
Skip tablar:export-auth — Breeze's auth scaffolding already exists. Profile/Settings stubs from Breeze remain in place.
3. Switching layout post-install
Edit config/tablar.php:
'layout' => 'condensed-top', // or other variant — see published config comments
'layout_light_topbar' => null,
'layout_light_sidebar' => true,
No file republish needed — value is read at render time.
4. Re-running install after upstream package update
composer update takielias/tablar
php artisan tablar:update
npm install && npm run dev
tablar:update refreshes deps + assets without re-running scaffolding (won't touch Controller.php, User.php, or auth views).
Common pitfalls
Route [profile] not defined—tablar:export-authnot run aftertablar:install. Either run it OR set'profile_url' => falseinconfig/tablar.phpto hide the dropdown link.- Unstyled layout —
npm run dev(orbuild) not run. Vite manifest missing. The publishedtabler.scssandtabler-init.jsneed to be compiled. tabler-iconsfont not loading —npm installskipped ornode_modules/not removed.tablar:installremovesnode_modules/to force a clean install; if you skipped that step, runrm -rf node_modules && npm install.- Theme toggle resets on navigation — Tabler core's
tabler-theme.jsstripsdata-bs-themeon defaultlight. Master layout's inline<head>script syncstablar.theme→tabler-themeon every load to compensate. Don't writetabler-themedirectly. - Controller patch reverts on every
composer install— publishedController.phplives in your app. If you re-publish via--force, it re-patches. Should not happen in CI as long asapp/is committed. - Multiple
use SoftDeletesinsertions on rerun — patcher is idempotent; checks\bSoftDeletes\bbefore inserting. Safe.
Configuration reference (top keys)
'use_route_url' => true, // resolve menu route keys via route() vs raw URL
'profile_url' => 'profile', // route name OR path; false to hide dropdown link
'setting_url' => 'settings',
'enable_notifications' => true, // bell-icon dropdown visibility
'header_buttons' => [...], // empty array hides chrome
'footer_buttons' => [...],
'layout' => 'horizontal',
'menu' => [...],
Related
- Skill
tablar-menu-development— menu schema and authoring. - Slash command
/laravel-boost:install-tablar-kit— wire tablar-kit on top of tablar. - Source:
src/Console/TablarInstallCommand.php,src/TablarPreset.php,src/stubs/.
Source: takielias/tablar — distributed by TomeVault.