The Dock API provides control over your application’s dock icon, including visibility, badges, bouncing, and context menus. Note that dock functionality is primarily available on macOS and some Linux desktop environments.
Basic Usage
use Native\Desktop\Facades\Dock;
Dock::show();
Dock::badge('5');
Dock::bounce();
Methods
Set a context menu for the dock icon.
A Menu instance with menu items
use Native\Desktop\Facades\Dock;
use Native\Desktop\Facades\Menu;
use Native\Desktop\Menu\Items\Label;
$menu = Menu::make(
Label::make('Show Window'),
Label::make('Quit')->accelerator('CmdOrCtrl+Q')
);
Dock::menu($menu);
show
Show the dock icon.
hide
Hide the dock icon.
icon
Set a custom icon for the dock.
Path to the icon image file
Dock::icon(storage_path('app/custom-icon.png'));
bounce
Bounce the dock icon to get the user’s attention.
type
string
default:"informational"
The bounce type: “informational” or “critical”
// Informational bounce (bounces once)
Dock::bounce();
// Critical bounce (bounces continuously until app is activated)
Dock::bounce('critical');
informational - Bounces the dock icon oncecritical - Bounces the dock icon continuously until the application becomes active
cancelBounce
Cancel a continuous bounce animation.
badge
Get or set the badge text on the dock icon.
The badge text to display. Pass null to get the current badge
Returns the current badge text when called without parameters, or null when setting
// Set a badge
Dock::badge('5');
// Get the current badge
$badge = Dock::badge();
// Clear the badge
Dock::badge('');
Dock functionality is primarily designed for macOS. On Linux, support depends on the desktop environment. On Windows, these methods may have no effect as Windows uses the taskbar instead of a dock.
Examples
Show Unread Count
use Native\Desktop\Facades\Dock;
$unreadCount = Message::where('read', false)->count();
if ($unreadCount > 0) {
Dock::badge((string) $unreadCount);
} else {
Dock::badge('');
}
Alert User with Critical Bounce
use Native\Desktop\Facades\Dock;
// Bounce until user opens the app
Dock::bounce('critical');
// Later, when user interacts with the app
Dock::cancelBounce();
use Native\Desktop\Facades\Dock;
use Native\Desktop\Facades\Menu;
use Native\Desktop\Menu\Items\Label;
use Native\Desktop\Menu\Items\Separator;
$dockMenu = Menu::make(
Label::make('New Message')->event('message.new'),
Label::make('Show Inbox')->event('inbox.show'),
Separator::make(),
Label::make('Preferences')->accelerator('CmdOrCtrl+,')
);
Dock::menu($dockMenu);