DESIGN.md
This document defines Coolify's UI design system for its Livewire + Blade + Alpine + Tailwind v4 frontend. The visual system covers the global shell, project and environment pages, application navigation, settings surfaces, tables, modals, toasts, terminals, and metrics.
Use this file as the source of truth for frontend design work. Update it in the same change whenever a new shared visual pattern or component is introduced.
Onboarding validation and live server validation checkpoints share
<x-checkpoint-item> (idle / pending / running / success / error) inside a
compact divided list, not legacy green check SVGs or fixed-width status rows.
Maintainer rules
- Keep the work frontend-focused unless existing data must be exposed to the view.
- Preserve routes, Livewire bindings, permissions, confirmations, and working interactions while changing layout and presentation.
- Add or update tests when a UI change affects behavior. Follow the testing requirements in
AGENTS.md.- Validate Blade with
docker exec coolify php artisan view:cache, then clear it withdocker exec coolify php artisan view:clear.- Build frontend assets in the Vite container with
docker exec coolify-vite npm run build.- Use existing components before adding another styling abstraction.
The interface is compact and product-focused:
<x-reicon>;—) in UI copy. Prefer a period, colon, comma, or
ASCII hyphen (-) for empty cells and separators.Avoid oversized titles, generic dashboard cards, strong shadows, thick dividers, native browser selects, and isolated colored buttons that do not match the current action styles.
PHP runs in the coolify container. The development app is normally available
at http://localhost:8000, with Vite on port 5173.
resources/css/app.css still contains unlayered global element rules for
headings, labels, and tables. Tailwind utilities are layered, so the
unlayered rules can win unexpectedly.
The settings and dense-surface CSS therefore lives as plain unlayered CSS near
the end of resources/css/app.css, beginning at:
/* Coollabs layer-card settings surfaces */
Important consequences:
.application-settings-form or
.application-settings-workspace;!important utilities;overflow: visible;scroll-margin-top: 7rem to clear both fixed navigation
layers;The surface ladder is defined in resources/css/app.css.
| Token | Light | Dark | Use |
|---|---|---|---|
--coollabs-canvas | near white | 10% neutral | page canvas |
--coollabs-elevated | 98% neutral | 15% neutral | shells and card headers |
--coollabs-base | white | 17% neutral | nested card bodies |
--coollabs-recessed | 96% neutral | 20% neutral | inputs and listboxes |
--coollabs-fill | 92.2% neutral | 26.9% neutral | dividers and passive fills |
--coollabs-line | translucent dark | 32% neutral | control borders |
--coollabs-hairline | 93.5% neutral | 26.9% neutral | shell rings |
--coollabs-subtle | 55.6% neutral | 70.8% neutral | labels and muted titles |
Accent behavior is intentionally theme-aware:
coollabs) for active controls, focus,
primary actions, and navigation accents.warning) for the same states because the
original purple did not provide sufficient text and ring contrast.Do not hard-code blue focus rings or leave yellow accent utilities active in light mode. Primary action patterns should normally follow:
bg-coollabs/10 text-coollabs ring-coollabs/25
dark:bg-warning/15 dark:text-warning dark:ring-warning/25
The filled top-level action/tab treatment uses the same palette at a restrained opacity rather than a fully saturated fill.
rounded-md) with an accent rail on
the left plus a solid neutral selected fill (bg-black/5 light,
bg-white/6 dark). Hover rows use the same radius. Do not use accent-tinted
gradients on nav rows; yellow washes look muddy on dark UI.Application and server pages use the same fixed second navigation layer
directly below the global topbar. Do not keep a large in-flow resource heading
or legacy .navbar-main tabs on one resource type while using the compact
layer-2 bar on another. Active tabs are a light brand fill:
Keep route-derived active state in Blade/Livewire. Do not rely only on Alpine state because it can disappear after polling or a Livewire morph.
The global topbar owns the current resource identity and its compact status
badges. Layer 2 owns route tabs, resource links, and contextual action buttons
only. If a resource is missing from x-top-breadcrumb, extend the global
topbar instead of repeating its name or status summary in layer 2. Mobile
resource navigation may repeat this context because the desktop global topbar
is hidden there.
Only add layer-2 tabs when they represent real sibling routes inside one
context. Never repeat main-sidebar destinations such as Dashboard, Projects,
Terminal, Servers, Sources, Destinations, or Storage as a second tab row. A
single collection page does not need a tab just to fill the bar; keep its
primary action in the page header instead. When tabs are useful, their left edge
uses the same compact pl-2 alignment as application navigation rather than
the content container's wide horizontal padding.
The dashboard is a compact overview, not a metrics wall. Use two full-width
sections that follow the projects-page grid pattern: projects first, then
servers. Keep one New action in the page header and let its modal choose the
resource type. Place active deployments above the resource grids as a compact,
live-updating table rather than a metric card. Communicate server health with
the shared status badge.
Every page opened directly from the main sidebar uses the same compact content shell:
coolbox, .navbar-main, or oversized subtitle block;x-empty anatomy for empty states;x-status-badge for state and x-reicon for all interface icons.Collection cards are min-h-28 or min-h-32, use a 32px icon tile, and keep
secondary metadata at 11px. They must not grow into dashboard-sized summary
cards. Sources, destinations, S3 storage, private keys, and shared-variable
scopes use this pattern.
Top-level settings families such as Team, Notifications, Keys & Tokens, and
instance Settings use a compact header followed by a small route-derived tab
strip. The active tab uses the same purple-light/yellow-dark tint as resource
tabs. Do not nest <button> elements inside tab links.
Treat every route family as one cohesive experience rather than styling only its index or most visible route:
coolbox/navbar-main/sub-menu-wrapper
to keep the family consistent.Do not leave a sibling route using old tabs, a large in-flow title, a browser select, or a different modal anatomy.
The New Resource page keeps its filter controls in the top layer card, then renders Applications, Databases, and Services as separate layer-card sections. Do not leave category headings and resource grids floating as uncontained content below the filter card.
Application and server configuration pages use the same 210px grouped,
icon-led sidebar and a full-width content column. The workspace is capped at
1180px, the sidebar becomes sticky at xl, and the sidebar label and first
content card start on the same visual line. Do not use the legacy
sub-menu-wrapper, native mobile page selects, or an in-flow row of top-level
tabs. Only show nested section anchors when a page has at least four useful
sections.
The shared workspace grid is:
<div
class="application-settings-workspace mt-8 grid min-w-0 gap-8
xl:mt-0 xl:grid-cols-[210px_minmax(0,1fr)] xl:gap-10">
<aside class="application-settings-navigation min-w-0 xl:sticky xl:top-26 xl:self-start">
...
</aside>
<div class="min-w-0 xl:mt-3">
...
</div>
</div>
Instance Settings constrains both x-settings.navbar and the workspace to the
same max-w-[1180px] shell.
Page titles (global): family H1s (x-dashboard.navbar with
titleOnDesktop="false", the default) hide at lg+, the same breakpoint as
the desktop shell (main sidebar + fixed layer-2 tabs). Below lg the mobile
topbar is used and the page title stays visible. Collection indexes (Servers,
Projects, …) always keep their H1; stack title above actions on narrow widths
so they never overlap. Resource in-flow names only render below md (when the
fixed resource tab bar is hidden). Fixed layer-2 spacers must be lg:h-12 to
match the bar height. Do not put the H1 beside the settings sidebar.
Standard content stack:
<div class="application-settings-workspace flex flex-col gap-6">
<x-application.settings-section ... />
<x-application.settings-section ... />
</div>
The current cross-page section gap is gap-6. Do not introduce extra top
padding on an individual page unless its toolbar is intentionally separated
from the first card.
Use a flex or grid stack with gap-6; do not use space-y-* between layer
cards. The layer-card root intentionally resets its own margin, so margin-based
spacing utilities can silently collapse.
Use resources/views/components/application/settings-section.blade.php.
Older manual shells may use .application-settings-section-header and
.application-settings-section-body; both must retain the same padded,
action-aligned anatomy as the component. Use the component for new work and
replace a manual shell when modifying it instead of creating another variant.
<x-application.settings-section
id="public-access-section"
title="Public access"
helper="How this section affects the resource.">
<x-slot:actions>
<x-forms.button>Action</x-forms.button>
</x-slot:actions>
...
</x-application.settings-section>
Anatomy:
flush mode for full-bleed tables;Header actions use an 8px top/right inset while the title keeps its 16px left inset. Do not leave a larger empty strip between the final action and the card's top-right corner.
Do not split one collection into a summary card followed by a table or log card. Keep its status/action in the header, its view switcher or toolbar at the top of a flush body, and its data in that same layer card. Repeated file editors are the opposite case: each file gets its own titled layer card so its content and actions remain clearly associated.
Concentric boxes must follow:
outer radius = inner radius + visible inset
Examples:
Do not give visibly inset parent and child boxes the same radius. Flush or edge-to-edge children are exempt because there is no visible inset to add.
Use an empty state when the section has no usable controls:
<x-empty size="sm" title="Nothing here" description="Explain what enables it.">
<x-slot:icon>
<x-reicon name="layers" class="size-8" />
</x-slot:icon>
</x-empty>
All normal controls are 32px high with an 8px radius.
The grid must match the controls visible in the current state:
Do not pick a column count from the maximum possible state if the normal state shows fewer controls.
Use x-forms.input and x-forms.textarea. Fields need visible vertical spacing
between the label and control. Password visibility uses the outline Reicon
eye/eye-off treatment from the shared input component.
Do not use native <select> on application routes, including mobile fallbacks.
Use:
<x-forms.listbox id="property" label="Setting" :options="[
['value' => true, 'label' => 'Enabled'],
['value' => false, 'label' => 'Disabled'],
]" onChange="instantSave" />
Boolean checkboxes should normally become descriptive two-option listboxes.
Use .live behavior only when the selection needs an immediate server
rerender.
Keep checkboxes for compact permission matrices and multi-select lists. Those
controls must use the shared x-forms.checkbox anatomy: an 18px rounded custom
box, purple checked fill in light mode, yellow checked fill in dark mode, and a
high-contrast check mark. Never expose the browser or Tailwind Forms default
checkbox on application pages.
The popup panel uses a 10px radius around 6px options with a 4px inset. Keep the option content left-aligned and size the panel to its content or trigger; do not create an unnecessarily wide menu.
Toolbar filter and sort buttons keep static labels (Filter, Sort). The
selected option is indicated inside the menu, not repeated on the trigger.
Instant-save listboxes must not flash back to an older value while Livewire is saving or morphing the DOM. Treat the Alpine selection as the current visual state until its request finishes:
preserveValue option so the morph does
not replace its newer Alpine value;preserveValue to controls whose value is owned by that interaction;
do not use it when external server events must replace the displayed value;wire:key values for rows containing listboxes. Do not include the
selected value in the key, because recreating the Alpine component causes a
visible reset;pointer-events or a disabled wrapper.The failure mode to avoid is: selection B is shown optimistically, selection A is chosen next, the response for B morphs the listbox back to B, then the later response finally shows A. The control should remain on the newest accepted selection throughout the save sequence.
Toolbar filters that can combine criteria use one multi-select listbox rather
than separate dropdowns or a single selected value. Follow the deployment
history filter in
resources/views/livewire/project/application/deployment/index.blade.php:
aria-multiselectable="true" on the listbox;Filter trigger;max-h-80 overflow-y-auto;Reset filters action in a separate footer below the
scrollable options, divided by a top border;Do not represent the empty state as a selectable All option. The footer reset
action is the single way to return the multi-select to its unfiltered state.
Dense tables use the shared x-table.* components so search, filters, sorting,
and backend loading states remain visually and behaviorally consistent:
<x-table.toolbar> owns the responsive search-left/actions-right layout;<x-table.search> owns the search icon, optional loading indicator, clear
action, sizing, and input anatomy;<x-table.filter> owns the static Filter trigger, active-count pill,
multi-select panel, scrollable options area, and Reset filters footer;<x-table.sort> owns the static Sort trigger and single-select panel;<x-table.loading> overlays only the changing table data for backend search,
filter, sort, and pagination requests.Tables continue to own their filter options, sort choices, headers, rows,
queries, permissions, and empty states. Backend-filtered or paginated tables
must use x-table.loading; frontend-only Alpine tables reuse the same toolbar
and control anatomy but do not show an artificial loading state.
.button;resources/views/components/unsaved-bar.blade.php is a compact floating
bottom-center pill. It contains:
On small viewports the pill is inset (inset-x-3) and stacks: full label on
the first line, Reset / Save on the second (right-aligned). From sm up it
returns to the centered single-row nowrap pill.
Do not restore the old full-width footer.
Deferred fields in one Livewire component use one floating unsaved bar and one submit action. Do not add a separate “Save configuration” button to every card. Selectors that are safe to persist independently should use the existing instant-save pattern.
Collections with many rows should use the Cloudflare-inspired table pattern:
Do not add a summary card above a table when it only repeats the row count, current page, or refresh interval. Keep counts and pagination in the footer. Background polling stays silent unless its state is actionable; do not add a “Live updates” badge just to explain that a table refreshes. Filters only render meaningful values; use the shared listbox instead of a number input or browser-native control.
The footer is always inside the table shell:
Showing X–Y of Z on the left;Hide the entire pagination footer when there is only one page (totalPages > 1).
A lone “1–2 of 2” bar with disabled controls adds noise and is unnecessary.
Use x-status-badge for resource and execution state. It is a small neutral
pill with a semantic dot, not a full colored rectangle.
Relevant classes:
.data-table.data-table-header.data-table-row.table-badgeCreate a page-specific grid class when columns differ. Add responsive rules that hide secondary columns before allowing horizontal overflow.
x-modal-input and confirmation dialogs reuse the layer-card shell:
Edit modals should use the same field layout and option set as their matching create modal.
The global search command palette (livewire:global-search) is a compact
top-anchored overlay:
⌘K on macOS, Ctrl+K on Windows/Linux) / / / ESC kbd chips matching the sidebar search trigger;ring-2 / ring-offset treatment;application-settings-section layer-card shell.Preserve keyboard navigation (arrow keys, Enter via focused links, Escape to
clear then close), / and mod+K (⌘K / Ctrl+K by OS) open shortcuts, and the multi-step
server → destination → project → environment create flow.
resources/views/components/toast.blade.php provides the global
window.toast(message, options) API and Livewire event handling.
Current toast behavior:
Do not bring back the old oversized dark rectangle.
Application and server browser terminals use the same browser-oriented console
shell, theme picker, compact header controls, and outline browser-terminal
Reicon. Hide a container switcher when only one container exists.
Runtime and deployment logs should feel like a clean terminal surface:
Metrics pages use separate layer cards for range selection, CPU, and memory. Charts follow the application metrics implementation:
Only add a metric if Sentinel exposes historical data for it. Current Sentinel history endpoints store CPU and memory. Root filesystem usage is included in the periodic push payload for threshold notifications, but it is not stored as a historical Sentinel metric and has no history endpoint, so it cannot power a disk-usage graph yet.
Use these as implementation references:
| Surface | Reference |
|---|---|
| Dashboard overview | resources/views/livewire/dashboard.blade.php |
| Top-level collection cards | resources/views/livewire/project/index.blade.php, resources/views/source/all.blade.php |
| Top-level family tabs | resources/views/components/team/navbar.blade.php, resources/views/components/notification/navbar.blade.php |
| General settings and form anatomy | resources/views/livewire/project/application/general.blade.php |
| Advanced settings | resources/views/livewire/project/application/advanced.blade.php |
| Fixed layer-2 resource navigation | resources/views/livewire/project/application/heading.blade.php, resources/views/livewire/server/navbar.blade.php |
| Grouped settings sidebar | resources/views/livewire/project/application/configuration.blade.php, resources/views/components/server/sidebar.blade.php |
| Dense environment table and footer | resources/views/livewire/project/shared/environment-variable/all.blade.php |
| Standard table toolbar controls | resources/views/components/table/* |
| Application metrics charts | resources/views/livewire/project/shared/metrics.blade.php |
| Browser terminal workspace | resources/views/livewire/terminal/index.blade.php |
| Layer card | resources/views/components/application/settings-section.blade.php |
| Custom dropdown | resources/views/components/forms/listbox.blade.php |
| Empty state | resources/views/components/empty.blade.php |
| Status pill | resources/views/components/status-badge.blade.php |
| Floating save pill | resources/views/components/unsaved-bar.blade.php |
| Global toast | resources/views/components/toast.blade.php |
| Command palette / global search | resources/views/livewire/global-search.blade.php |
| Outline icons | resources/views/components/reicon.blade.php |
| Shared styling | resources/css/app.css, resources/css/utilities.css |
| HTTP error pages | resources/views/components/error-page.blade.php, resources/views/errors/* |
HTTP error pages (400, 401, 402, 403, 404, 419, 429, 500, 503) use the shared
<x-error-page> component on the public auth-style canvas: theme-aware status
code, compact title and muted description, neutral .button actions, and an
auth-text-link-style Contact support link. Keep copy sentence-case and avoid
oversized 200px status numbers.
gap-6.outer = inner + inset.x-status-badge, x-empty, and x-reicon.git diff --check.coolify container.coolify-vite.