NativePHP Desktop

https://nativephp.com/docs/desktop/2
Admin
NativePHP is a framework for rapidly building rich, native cross-platform desktop applications using...
Tokens:90,858
Snippets:889
Trust Score:8.5
Update:1 day ago
Show doc for...
Tokens:
Raw
### Start a Child Process with environment variables

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Provide extra environment variables when starting a process via the `$env` parameter of the `start` method.

```php
ChildProcess::start(
    cmd: 'tail ...',
    alias: 'tail',
    env: [
        'CUSTOM_ENV_VAR' => 'custom value',
    ]
);
```

--------------------------------

### Install wine for cross-compilation on Linux

Source: https://nativephp.com/docs/desktop/2/publishing/building

Example installation of wine for Debian-based distributions (Ubuntu). Required for compiling Windows binaries; NSIS requires 32-bit wine when building x64 applications.

```bash
# Example installation of wine for Debian based distributions (Ubuntu)
dpkg --add-architecture i386
apt-get -y update
apt-get -y install wine32

# Example installation of wine for Debian based distributions (Ubuntu)
dpkg --add-architecture i386
apt-get -y update
apt-get -y install wine32
```

--------------------------------

### Start a child process with ChildProcess::start

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Starts a child process using the ChildProcess facade. Requires a unique alias. The start method returns a Native\Desktop\ChildProcess instance, but the process may not have started yet; listen for the ProcessSpawned event to confirm.

```php
use Native\Desktop\Facades\ChildProcess;
 
ChildProcess::start(
    cmd: 'tail -f storage/logs/laravel.log',
    alias: 'tail'
);

use Native\Desktop\Facades\ChildProcess;

ChildProcess::start(
    cmd: 'tail -f storage/logs/laravel.log',
    alias: 'tail'
);
```

--------------------------------

### Quit and install update with AutoUpdater::quitAndInstall()

Source: https://nativephp.com/docs/desktop/2/publishing/updating

Call quitAndInstall() to quit the application and install the update. The application will relaunch automatically. This method is optional; any successfully downloaded update will be applied on the next application start.

```php
use Native\Desktop\Facades\AutoUpdater;

AutoUpdater::quitAndInstall();
```

--------------------------------

### Start a Child Process with command line arguments

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Pass arguments to the program via the `$cmd` parameter of the `start` method, accepting a string or an array.

```php
ChildProcess::start(
    cmd: ['tail', '-f', 'storage/logs/laravel.log'],
    alias: 'tail'
);
```

--------------------------------

### Start bundled executable with ChildProcess

Source: https://nativephp.com/docs/desktop/2/digging-deeper/files

Retrieves the path to a bundled executable and starts it as a child process with an alias. Requires the 'extras' disk and the ChildProcess facade.

```php
use Illuminate\Support\Facades\Storage;
use Native\Desktop\Facades\ChildProcess;

// Get the path to a bundled executable
$toolPath = Storage::disk('extras')->path('my-tool.sh');

ChildProcess::start(
    cmd: $toolPath,
    alias: 'my-tool'
);
```

--------------------------------

### Start a Child Process with ChildProcess::start

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Use the ChildProcess facade to spawn a non-blocking background process. The example starts a tail command on a Laravel log file with an alias. Note that command arguments may differ between platforms, and it's recommended to use full paths for binaries when possible.

```php
ChildProcess::start(
    cmd: 'tail -f storage/logs/laravel.log',
    alias: 'tail'
);

ChildProcess::start(
    cmd: 'tail -f storage/logs/laravel.log',
    alias: 'tail'
);
```

--------------------------------

### Run the NativePHP installer

Source: https://nativephp.com/docs/desktop/2/getting-started/installation

Run this artisan command to publish the service provider, configuration file, add the native:dev script, register post-update-cmd, and install Electron dependencies. Should be run on new machines and in CI.

```bash
php artisan native:install
```

--------------------------------

### Get all displays with Screen::displays()

Source: https://nativephp.com/docs/desktop/2/the-basics/screens

Calls the `displays` method on the Screen facade to get an array of display objects. The example shows the structure of the returned array, including bounds, size, work area, and other properties.

```php
$screens = Screen::displays();

[
  0 => [
    'bounds' => [
      'x' => 0,
      'y' => 0,
      'width' => 2560,
      'height' => 1440,
    ],
    'detected' => true,
    'id' => 2026675401,
    'internal' => false,
    'label' => 'U3277WB',
    'size' => [
      'width' => 2560,
      'height' => 1440,
    ],
    'workArea' => [
      'x' => 0,
      'y' => 25,
      'width' => 2560,
      'height' => 1345,
    ],
    // ...
  ],
  // ...
]
```

--------------------------------

### ChildProcess::start

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Starts a child process with optional environment variables and command line arguments. The command can be a string or an array.

```APIDOC
## ChildProcess::start

### Description
Starts a child process. Allows providing environment variables and command line arguments.

### Method
start

### Signature
`ChildProcess::start(cmd: string|array, alias: string, env: array)`

### Parameters
- **cmd** (string|array) - Required - The command to run. Can be a string or an array of arguments.
- **alias** (string) - Required - The alias for the child process.
- **env** (array) - Optional - Additional environment variables to set for the process.

### Request Example
```php
ChildProcess::start(
    cmd: 'tail ...',
    alias: 'tail',
    env: [
        'CUSTOM_ENV_VAR' => 'custom value',
    ]
);

ChildProcess::start(
    cmd: ['tail', '-f', 'storage/logs/laravel.log'],
    alias: 'tail'
);
```

### Response
No return value is documented.
```

--------------------------------

### AutoUpdater::quitAndInstall()

Source: https://nativephp.com/docs/desktop/2/publishing/updating

Quits the application and installs the update. The application will relaunch automatically. This method is optional; any successfully downloaded update will be applied on the next application start.

```APIDOC
## AutoUpdater::quitAndInstall()

### Description
Quits the application and installs the update. The application will relaunch automatically. This method is optional; any successfully downloaded update will be applied on the next application start.

### Method
`quitAndInstall`

### Facade
`Native\Desktop\Facades\AutoUpdater`

### Example
```php
use Native\Desktop\Facades\AutoUpdater;

AutoUpdater::quitAndInstall();
```
```

--------------------------------

### ChildProcess::start

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Starts a child process with a unique alias. Returns a Native\Desktop\ChildProcess instance. The process may not start immediately; listen for the ProcessSpawned event to confirm.

```APIDOC
## ChildProcess::start

### Description
Starts a child process with a unique alias. Returns a Native\Desktop\ChildProcess instance. The process may not start immediately; listen for the ProcessSpawned event to confirm.

### Method
start

### Parameters
- **cmd** (string|array) - Required - The command to run. Can be a string or an array of arguments.
- **alias** (string) - Required - Unique alias to reference the process.
- **cwd** (string) - Optional - Current working directory for the process. Defaults to the application's working directory.
- **persistent** (bool) - Optional - If true, the runtime ensures the process is always running, restarting it if it crashes.

### Example
```php
use Native\Desktop\Facades\ChildProcess;

ChildProcess::start(
    cmd: 'tail -f storage/logs/laravel.log',
    alias: 'tail'
);
```
```

--------------------------------

### Set web preferences with webPreferences()

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Pass an optional webPreferences configuration array to customize Electron window behavior. The example enables nodeIntegration, spellcheck, and backgroundThrottling.

```php
Window::open()
    ->webPreferences([
        'nodeIntegration' => true,
        'spellcheck' => true,
        'backgroundThrottling' => true,
    ]);
```

--------------------------------

### Default NativeAppServiceProvider implementation

Source: https://nativephp.com/docs/desktop/2/the-basics/app-lifecycle

The default service provider published by `php artisan native:install` to `app/Providers/NativeAppServiceProvider.php`. It implements `ProvidesPhpIni` and includes a `boot()` method that opens a window and a `phpIni()` method returning an empty array of directives.

```php
namespace App\Providers;

use Native\Desktop\Facades\Window;
use Native\Desktop\Contracts\ProvidesPhpIni;

class NativeAppServiceProvider implements ProvidesPhpIni
{
    /**
     * Executed once the native application has been booted.
     * Use this method to open windows, register global shortcuts, etc.
     */
    public function boot(): void
    {
        Window::open();
    }

    /**
     * Return an array of php.ini directives to be set.
     */
    public function phpIni(): array
    {
        return [
        ];
    }
}
```

--------------------------------

### Print with Custom Page Size and Orientation

Source: https://nativephp.com/docs/desktop/2/the-basics/system

Example settings array for custom page size (A4) and landscape orientation. Passed as the third argument to System::print().

```php
// Print with custom page size and orientation
$settings = [
    'pageSize' => 'A4',
    'landscape' => true,
];

System::print('<html>...', $printer, $settings);

// Print with custom page size and orientation
$settings = [
    'pageSize' => 'A4',
    'landscape' => true,
];

System::print('<html>...', $printer, $settings);
```

--------------------------------

### Set webPreferences with webPreferences()

Source: https://nativephp.com/docs/desktop/2/the-basics/menu-bar

Pass a webPreferences configuration array to MenuBar::create() to customize menu bar window behavior and available web features. The example enables nodeIntegration, spellcheck, and backgroundThrottling. Defaults and restrictions are the same as for Windows.

```php
MenuBar::create()
    ->webPreferences([
        'nodeIntegration' => true,
        'spellcheck' => true,
        'backgroundThrottling' => true,
    ]);

MenuBar::create()
    ->webPreferences([
        'nodeIntegration' => true,
        'spellcheck' => true,
        'backgroundThrottling' => true,
    ]);
```

--------------------------------

### Install nativephp/desktop via Composer

Source: https://nativephp.com/docs/desktop/2/getting-started/installation

Run this command in your Laravel project root to install the NativePHP Desktop package. Requires PHP 8.3+, Laravel 11+, and Node 22+.

```bash
composer require nativephp/desktop
```

--------------------------------

### Print Multiple Copies with Duplex and Color Settings

Source: https://nativephp.com/docs/desktop/2/the-basics/system

Example settings for multiple copies, duplex mode, and color/monochrome. Duplex mode options: 'simplex', 'shortEdge', 'longEdge'. Color false for monochrome.

```php
// Print multiple copies with duplex
$settings = [
    'copies' => 3,
    'duplexMode' => 'longEdge', // 'simplex', 'shortEdge', 'longEdge'
    'color' => false, // true for color, false for monochrome
];

System::print('<html>...', $printer, $settings);

// Print multiple copies with duplex
$settings = [
    'copies' => 3,
    'duplexMode' => 'longEdge', // 'simplex', 'shortEdge', 'longEdge'
    'color' => false, // true for color, false for monochrome
];

System::print('<html>...', $printer, $settings);
```

--------------------------------

### Example test case for GlobalShortcut fake

Source: https://nativephp.com/docs/desktop/2/testing/global-shortcut

Use GlobalShortcut::fake() to mock global shortcuts, then make a request and assert the shortcut key, registered count, and event. This example uses PHPUnit attributes and the OpenPreferencesEvent class.

```php
use Native\Desktop\Facades\GlobalShortcut;
 
#[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    GlobalShortcut::fake();
 
    $this->get('/whatever-action');
 
    GlobalShortcut::assertKey('CmdOrCtrl+,');
    GlobalShortcut::assertRegisteredCount(1);
    GlobalShortcut::assertEvent(OpenPreferencesEvent::class);
}

use Native\Desktop\Facades\GlobalShortcut;

#[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    GlobalShortcut::fake();

    $this->get('/whatever-action');

    GlobalShortcut::assertKey('CmdOrCtrl+,');
    GlobalShortcut::assertRegisteredCount(1);
    GlobalShortcut::assertEvent(OpenPreferencesEvent::class);
}
```

--------------------------------

### Template image file names

Source: https://nativephp.com/docs/desktop/2/the-basics/menu-bar

Example file names for a template image icon. Append 'Template' to the file name to enable automatic template image conversion.

```text
menuBarIconTemplate.png
[email protected]
```

--------------------------------

### Import Settings facade

Source: https://nativephp.com/docs/desktop/2/the-basics/settings

Import the Settings facade from Native\Desktop\Facades.

```php
use Native\Desktop\Facades\Settings;
```

--------------------------------

### Example test case for faking child processes

Source: https://nativephp.com/docs/desktop/2/testing/child-process

Use this test to verify that a child process is started and receives a specific message. It fakes the ChildProcess facade, makes a GET request, and asserts the process was started with the alias 'background-worker' and that the message payload matches the expected JSON.

```php
use Native\Desktop\Facades\ChildProcess;
 
#[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    ChildProcess::fake();
 
    $this->get('/whatever-action');
 
    ChildProcess::assertGet('background-worker');
    ChildProcess::assertMessage(fn (string $message, string|null $alias) => $message === '{"some-payload":"for-the-worker"}' && $alias === null);
}

use Native\Desktop\Facades\ChildProcess;

#[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    ChildProcess::fake();

    $this->get('/whatever-action');

    ChildProcess::assertGet('background-worker');
    ChildProcess::assertMessage(fn (string $message, string|null $alias) => $message === '{"some-payload":"for-the-worker"}' && $alias === null);
}
```

--------------------------------

### Run the NativePHP development server with php artisan native:run

Source: https://nativephp.com/docs/desktop/2/getting-started/installation

Use this command to start your Laravel application in a native desktop window. Before running it, test the app in the browser to address any exceptions that may be harder to spot in the native context.

```bash
php artisan native:run
```

--------------------------------

### Get cursor position with Screen::cursorPosition()

Source: https://nativephp.com/docs/desktop/2/the-basics/screens

Calls the `cursorPosition` method on the Screen facade to get the current absolute position of the mouse cursor. The example shows the returned object with x and y coordinates.

```php
$position = Screen::cursorPosition();

(object) [
   'x' => 627,
   'y' => 168,
]
```

--------------------------------

### Import System facade

Source: https://nativephp.com/docs/desktop/2/the-basics/system

Import the System facade from the Native\Desktop\Facades namespace.

```php
use Native\Desktop\Facades\System;
```

--------------------------------

### Import App facade

Source: https://nativephp.com/docs/desktop/2/the-basics/application

Add this use statement to the top of your file to use the App facade.

```php
use Native\Desktop\Facades\App;

use Native\Desktop\Facades\App;
```

--------------------------------

### php artisan native:run

Source: https://nativephp.com/docs/desktop/2/getting-started/commands

Starts the NativePHP development server, which builds and runs your Electron app locally. Supports options to skip queue worker, focus, dependencies, and choose installer.

```APIDOC
## [COMMAND] php artisan native:run

### Description
Start the NativePHP development server, which builds and runs your Electron app locally.

### Method
Artisan Command

### Command
php artisan native:run

### Options
- `--no-queue` - Don't start a queue worker alongside the app
- `--no-focus` - Don't focus the app window on launch
- `-D`, `--no-dependencies` - Skip installing npm dependencies
- `--installer=npm` - The package installer to use: `npm` or `yarn`

### Example
```
php artisan native:run
```
```

--------------------------------

### Retrieve all windows with Window::all()

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Use `Window::all()` to retrieve all open windows and iterate over them.

```php
foreach (Window::all() as $window) {
    $window->url(route('home'));
}

foreach (Window::all() as $window) {
    $window->url(route('home'));
}
```

--------------------------------

### Example test case for QueueWorker::fake() and assertUp

Source: https://nativephp.com/docs/desktop/2/testing/queue-worker

This test case fakes the QueueWorker, performs a GET request to '/whatever-action', and asserts that the queue worker is up with a custom alias. It uses the QueueConfig DTO to check the alias.

```php
use Native\Desktop\Facades\QueueWorker;
use Native\Desktop\DTOs\QueueConfig;
 
#[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    QueueWorker::fake();
 
    $this->get('/whatever-action');
 
    QueueWorker::assertUp(fn (QueueConfig $config) => $config->alias === 'custom');
}
```

--------------------------------

### Relaunch the app with App::relaunch

Source: https://nativephp.com/docs/desktop/2/the-basics/application

Quits and relaunches the app.

```php
App::relaunch();

App::relaunch();
```

--------------------------------

### Example test case using PowerMonitor::fake() and assertGetSystemIdleState

Source: https://nativephp.com/docs/desktop/2/testing/power-monitor

Use this test to fake the PowerMonitor facade and assert that the getSystemIdleState method was called with the expected argument. The test makes a GET request to '/whatever-action' and then asserts the call.

```php
use Native\Desktop\Facades\PowerMonitor;
 
#[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    PowerMonitor::fake();
 
    $this->get('/whatever-action');
 
    PowerMonitor::assertGetSystemIdleState('...');
}

use Native\Desktop\Facades\PowerMonitor;

#[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    PowerMonitor::fake();

    $this->get('/whatever-action');

    PowerMonitor::assertGetSystemIdleState('...');
}
```

--------------------------------

### Import Alert facade

Source: https://nativephp.com/docs/desktop/2/the-basics/alerts

Import the Alert facade from the Native\Desktop\Facades namespace.

```php
use Native\Desktop\Facades\Alert;
```

--------------------------------

### Get Current Thermal State with PowerMonitor::getCurrentThermalState

Source: https://nativephp.com/docs/desktop/2/the-basics/power-monitor

Retrieves the current thermal state as a ThermalStatesEnum value. The example checks if the state is CRITICAL and prints a comment. Possible enum values are UNKNOWN, NOMINAL, FAIR, SERIOUS, and CRITICAL.

```php
use Native\Desktop\Enums\ThermalStatesEnum;
use Native\Desktop\Facades\PowerMonitor;
 
$thermalState = PowerMonitor::getCurrentThermalState();
 
if ($state === ThermalStatesEnum::CRITICAL) {
    // Wow, the CPU is running hot!
}

use Native\Desktop\Enums\ThermalStatesEnum;
use Native\Desktop\Facades\PowerMonitor;

$thermalState = PowerMonitor::getCurrentThermalState();

if ($state === ThermalStatesEnum::CRITICAL) {
    // Wow, the CPU is running hot!
}
```

--------------------------------

### Import Screen facade

Source: https://nativephp.com/docs/desktop/2/the-basics/screens

Import the Screen facade from the Native\Desktop\Facades namespace.

```php
use Native\Desktop\Facades\Screen;
```

--------------------------------

### Example test case for faking Windows

Source: https://nativephp.com/docs/desktop/2/testing/windows

Use this test to verify window operations (opened, closed, hidden) after a request. It fakes HTTP and the Window facade, then asserts that a window with a name starting with 'window-name' was opened, and that 'window-name' was closed and hidden.

```php
use Native\Desktop\Facades\Window;
use Illuminate\Support\Facades\Http;
 
 #[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    Http::fake();
    Window::fake();
 
    $this->get('/whatever-action');
 
    Window::assertOpened(fn (string $windowId) => Str::startsWith($windowId, ['window-name']));
    Window::assertClosed('window-name');
    Window::assertHidden('window-name');
}

use Native\Desktop\Facades\Window;
use Illuminate\Support\Facades\Http;

 #[\PHPUnit\Framework\Attributes\Test]
public function example(): void
{
    Http::fake();
    Window::fake();

    $this->get('/whatever-action');

    Window::assertOpened(fn (string $windowId) => Str::startsWith($windowId, ['window-name']));
    Window::assertClosed('window-name');
    Window::assertHidden('window-name');
}
```

--------------------------------

### Create application menu with Menu::create()

Source: https://nativephp.com/docs/desktop/2/the-basics/application-menu

Creates and registers a new application menu in the boot method of NativeAppServiceProvider. Pass menu items as parameters. The Menu::app() item is only available on macOS.

```php
namespace App\Providers;

use Native\Desktop\Facades\Menu;
use Native\Desktop\Facades\Window;

class NativeAppServiceProvider
{
    public function boot(): void
    {
        Menu::create(
            Menu::app(), // Only on macOS
            Menu::file(),
            Menu::edit(),
            Menu::view(),
            Menu::window(),
        );

        Window::open();
    }
}
```

--------------------------------

### php artisan native:install

Source: https://nativephp.com/docs/desktop/2/getting-started/commands

Installs NativePHP into your Laravel application. Supports options to force overwrite, publish the Electron project, and choose the package installer.

```APIDOC
## [COMMAND] php artisan native:install

### Description
Install NativePHP into your Laravel application.

### Method
Artisan Command

### Command
php artisan native:install

### Options
- `--force` - Overwrite existing files by default
- `--publish` - Publish the Electron project to your project's root
- `--installer=npm` - The package installer to use: `npm` or `yarn`

### Example
```
php artisan native:install
```
```

--------------------------------

### Get a setting value

Source: https://nativephp.com/docs/desktop/2/the-basics/settings

Retrieve a setting using the get method.

```php
$value = Settings::get('key');
```

--------------------------------

### Run composer update and native:install

Source: https://nativephp.com/docs/desktop/2/getting-started/upgrade-guide

After updating composer.json, run `composer update` and then `php artisan native:install`. The `native:install` script is automatically registered as a `post-update-cmd`, so it doesn't need to be run manually after future composer updates.

```bash
composer update
php artisan native:install
```

--------------------------------

### Open a window with Window::open() in NativeAppServiceProvider

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Use the Window facade to open a native window. Typically placed in the boot() method of NativeAppServiceProvider. The window automatically loads the root URL of the application. You can pass a unique identifier to open() to distinguish multiple windows; the default ID is 'main'.

```php
namespace App\Providers;

use Native\Desktop\Facades\Window;

class NativeAppServiceProvider
{
    public function boot(): void
    {
        Window::open()
            ->width(800)
            ->height(800);
    }
}
```

--------------------------------

### Get system idle time with getSystemIdleTime

Source: https://nativephp.com/docs/desktop/2/the-basics/power-monitor

Use `PowerMonitor::getSystemIdleTime()` to get the number of seconds the system has been idle. Returns an integer value.

```php
use Native\Desktop\Facades\PowerMonitor;
 
$seconds = PowerMonitor::getSystemIdleTime();

use Native\Desktop\Facades\PowerMonitor;

$seconds = PowerMonitor::getSystemIdleTime();
```

--------------------------------

### Create a menu bar for an app with windows using showDockIcon()

Source: https://nativephp.com/docs/desktop/2/the-basics/menu-bar

Use MenuBar::create()->showDockIcon() to create a menu bar while keeping the dock icon visible, typically for applications that already use windows.

```php
namespace App\Providers;

use Native\Desktop\Facades\MenuBar;

class NativeAppServiceProvider
{
    public function boot(): void
    {
        MenuBar::create()
            ->showDockIcon();
    }
}
```

--------------------------------

### Directory structure for extras/ folder

Source: https://nativephp.com/docs/desktop/2/digging-deeper/files

Shows the required directory layout for bundling extra files. Place files like my-tool.sh, my-tool.exe, and sample.csv in an 'extras/' directory at the project root. These files are automatically bundled during the build process.

```plaintext
your-project/
├── extras/
│   ├── my-tool.sh
│   ├── my-tool.exe
│   └── sample.csv
├── app/
└── ...
```

--------------------------------

### Get a single child process by alias

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Use the ChildProcess facade's get method to retrieve a running process by its alias. Returns a Native\Desktop\ChildProcess instance.

```php
$tail = ChildProcess::get('tail');

$tail = ChildProcess::get('tail');
```

--------------------------------

### Window::open()->width() and height()

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Specifies the width and height of the window.

```APIDOC
## Window::open()->width() and height()

### Description
Specifies the width and height of the window.

### Methods
- `Window::open()->width($width)`
- `Window::open()->height($height)`

### Parameters
- **$width** (int) - Required - The width of the window.
- **$height** (int) - Required - The height of the window.

### Example
```php
Window::open()
    ->width(800)
    ->height(800);
```
```

--------------------------------

### Enable open at login with App::openAtLogin(true)

Source: https://nativephp.com/docs/desktop/2/the-basics/application

Enables the app to open at login. Available only on macOS and Windows.

```php
App::openAtLogin(true);

App::openAtLogin(true);
```

--------------------------------

### Native\Desktop\Events\AutoUpdater\CheckingForUpdate

Source: https://nativephp.com/docs/desktop/2/publishing/updating

Dispatched when checking for an available update has started.

```APIDOC
## Event: Native\Desktop\Events\AutoUpdater\CheckingForUpdate

### Description
Dispatched when checking for an available update has started.

### Event Class
`Native\Desktop\Events\AutoUpdater\CheckingForUpdate`

### Properties
None documented.
```

--------------------------------

### Window::open()

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Opens a new window. Accepts an optional unique identifier. If no ID is provided, 'main' is used. Can be chained with configuration methods.

```APIDOC
## Window::open()

### Description
Opens a new window. Accepts an optional unique identifier. If no ID is provided, 'main' is used. Can be chained with configuration methods.

### Method
`Window::open($id = null)`

### Parameters
- **$id** (string|null) - Optional - Unique identifier for the window. Defaults to 'main'.

### Example
```php
Window::open('home')
    ->width(800)
    ->height(800);
```
```

--------------------------------

### Define hotkeys via parameter or chainable method

Source: https://nativephp.com/docs/desktop/2/the-basics/application-menu

Shows two equivalent ways to set a hotkey on a menu item: using the hotkey parameter or the hotkey() method. Hotkeys only fire when a window is focused or the context menu is open.

```php
Menu::label('Quick search', hotkey: 'Ctrl+K');

// Or

Menu::label('Quick search')->hotkey('Ctrl+K');
```

--------------------------------

### Set current working directory with $cwd parameter

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Starts a child process with an explicit current working directory by passing a string path to the $cwd parameter of the start method. By default, the child process uses the application's working directory.

```php
ChildProcess::start(
    cmd: ['tail', '-f', 'logs/laravel.log'],
    alias: 'tail',
    cwd: storage_path()
);

ChildProcess::start(
    cmd: ['tail', '-f', 'logs/laravel.log'],
    alias: 'tail',
    cwd: storage_path()
);
```

--------------------------------

### Set window size with width() and height()

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Use the width() and height() methods to specify the size of the window.

```php
Window::open()
    ->width(800)
    ->height(800);

Window::open()
    ->width(800)
    ->height(800);
```

--------------------------------

### App::version()

Source: https://nativephp.com/docs/desktop/2/the-basics/application

Gets the current app version as defined in the config/nativephp.php file.

```APIDOC
## App::version()

### Description
Gets the current app version. The version is defined in the `config/nativephp.php` file.

### Method
App::version()

### Parameters
None.

### Request Example
```php
$version = App::version();
```

### Response
Returns the app version string.
```

--------------------------------

### Dialog::withHiddenFiles()

Source: https://nativephp.com/docs/desktop/2/the-basics/dialogs

Shows hidden files (files that start with a dot) in the file dialog.

```APIDOC
## Dialog::withHiddenFiles()

### Description
Shows hidden files (files that start with a dot) in the file dialog.

### Method
`withHiddenFiles()`

### Parameters
None.

### Example
```php
Dialog::new()
    ->withHiddenFiles()
    ->open();
```
```

--------------------------------

### Create a standalone menu bar with MenuBar::create()

Source: https://nativephp.com/docs/desktop/2/the-basics/menu-bar

Use the MenuBar facade in the boot method of NativeAppServiceProvider to create a menu bar. By default, this hides the dock icon and opens the root URL of the application.

```php
namespace App\Providers;

use Native\Desktop\Facades\MenuBar;

class NativeAppServiceProvider
{
    public function boot(): void
    {
        MenuBar::create();
    }
}
```

--------------------------------

### Get a setting with a static default value

Source: https://nativephp.com/docs/desktop/2/the-basics/settings

Provide a default value to return if the setting does not exist.

```php
$value = Settings::get('key', 'default');
```

--------------------------------

### Show hidden files with withHiddenFiles()

Source: https://nativephp.com/docs/desktop/2/the-basics/dialogs

Enables showing hidden files (files starting with a dot) in the dialog.

```php
Dialog::new()
    ->withHiddenFiles()
    ->open();
```

--------------------------------

### Import Dialog facade

Source: https://nativephp.com/docs/desktop/2/the-basics/dialogs

Import the Dialog facade from the Native\Desktop namespace.

```php
use Native\Desktop\Dialog;

use Native\Desktop\Dialog;
```

--------------------------------

### Get a setting with a closure default value

Source: https://nativephp.com/docs/desktop/2/the-basics/settings

Provide a closure as the default value to return if the setting does not exist.

```php
$value = Settings::get('key', function () {
        return 'default';
    });
```

--------------------------------

### Get current app version with App::version

Source: https://nativephp.com/docs/desktop/2/the-basics/application

Returns the current app version as defined in config/nativephp.php.

```php
$version = App::version();

$version = App::version();
```

--------------------------------

### Import Clipboard facade

Source: https://nativephp.com/docs/desktop/2/the-basics/clipboard

Import the Clipboard facade from the NativePHP desktop package.

```php
use Native\Desktop\Facades\Clipboard;
```

--------------------------------

### Get app badge count with App::badgeCount()

Source: https://nativephp.com/docs/desktop/2/the-basics/application

Returns the current badge count when called without arguments.

```php
$badgeCount = App::badgeCount();

$badgeCount = App::badgeCount();
```

--------------------------------

### Window::all()

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Retrieves all open windows.

```APIDOC
## Window::all()

### Description
Retrieves all open windows.

### Method
`Window::all()`

### Return Value
- **array** - An array of window objects.

### Example
```php
foreach (Window::all() as $window) {
    $window->url(route('home'));
}
```
```

--------------------------------

### MenuBar::create()->width() and height()

Source: https://nativephp.com/docs/desktop/2/the-basics/menu-bar

Sets the width and height of the menu bar window.

```APIDOC
## MenuBar::create()->width() and height()

### Description
Sets the width and height of the menu bar window.

### Method
`width` and `height`

### Parameters
- `width` (int) - Required - The width in pixels.
- `height` (int) - Required - The height in pixels.

### Example
```php
MenuBar::create()
    ->width(800)
    ->height(600);
```
```

--------------------------------

### MenuBar::create()->vibrancy('light')

Source: https://nativephp.com/docs/desktop/2/the-basics/menu-bar

Applies a macOS vibrancy effect to the menu bar window. The 'light' value is an example.

```php
MenuBar::create()->vibrancy('light');
```

--------------------------------

### Window::open()->fullscreen()

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Opens the window in full screen mode.

```APIDOC
## Window::open()->fullscreen()

### Description
Opens the window in full screen mode.

### Method
N/A (PHP method call)

### Endpoint
N/A

### Parameters
None.

### Request Example
```php
Window::open()->fullscreen();
```

### Response
No return value.
```

--------------------------------

### Get all running child processes

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Use the ChildProcess facade's all method to retrieve an array of all running processes as Native\Desktop\ChildProcess instances.

```php
$processes = ChildProcess::all();

$processes = ChildProcess::all();
```

--------------------------------

### Update class imports from Native\Laravel to Native\Desktop

Source: https://nativephp.com/docs/desktop/2/getting-started/upgrade-guide

Replace all occurrences of Native\Laravel with Native\Desktop in your codebase. The example shows the before and after for a Window facade import.

```php
use Native\Laravel\Facades\Window;
```

```php
use Native\Desktop\Facades\Window;
```

--------------------------------

### Store PDF from System::printToPDF()

Source: https://nativephp.com/docs/desktop/2/the-basics/system

Shows how to decode the base64 PDF data and save it to disk using Laravel's Storage facade. Uses the 'desktop' disk.

```php
use Illuminate\Support\Facades\Storage;

$pdf = System::printToPDF('<html>...');

Storage::disk('desktop')->put('My Awesome File.pdf', base64_decode($pdf));

use Illuminate\Support\Facades\Storage;

$pdf = System::printToPDF('<html>...');

Storage::disk('desktop')->put('My Awesome File.pdf', base64_decode($pdf));
```

--------------------------------

### NotificationActionClicked Event

Source: https://nativephp.com/docs/desktop/2/the-basics/notifications

Event triggered when an action button on a notification is clicked. Contains an $index property indicating which button was clicked, starting at 0.

```APIDOC
## NotificationActionClicked Event

### Description
Event triggered when an action button on a notification is clicked. Contains an $index property indicating which button was clicked, starting at 0.

### Event Class
`Native\Desktop\Events\Notifications\NotificationActionClicked`

### Properties
- **$index** (int) - The index of the clicked action button. Indexes start at 0.

### Example
```php
use Native\Desktop\Events\Notifications\NotificationActionClicked;

Notification::title('Do you accept?')
    ->addAction('Accept')  // This action will be $index = 0
    ->addAction('Decline') // This action will be $index = 1
    ->show();

Event::listen(NotificationActionClicked::class, function (NotificationActionClicked $event) {
    if ($event->index === 0) {
        // 'Accept' clicked
    } elseif ($event->index === 1) {
        // 'Decline' clicked
    }
});
```
```

--------------------------------

### Mark a process as persistent

Source: https://nativephp.com/docs/desktop/2/digging-deeper/child-processes

Starts a child process with the persistent option set to true, ensuring the runtime restarts the process if it crashes, similar to supervisord.

```php
ChildProcess::start(
    cmd: ['tail', '-f', 'logs/laravel.log'],
    alias: 'tail',
    persistent: true
);

ChildProcess::start(
    cmd: ['tail', '-f', 'logs/laravel.log'],
    alias: 'tail',
    persistent: true
);
```

--------------------------------

### App::relaunch()

Source: https://nativephp.com/docs/desktop/2/the-basics/application

Quits and relaunches the application.

```APIDOC
## App::relaunch()

### Description
Quits the application and relaunches it.

### Method
App::relaunch()

### Parameters
None.

### Request Example
```php
App::relaunch();
```

### Response
No return value.
```

--------------------------------

### Run a build with php artisan native:build

Source: https://nativephp.com/docs/desktop/2/publishing/building

Builds the application for the current platform and architecture. Run this command in your project root.

```bash
php artisan native:build

php artisan native:build
```

--------------------------------

### Check Battery Power with PowerMonitor::isOnBatteryPower

Source: https://nativephp.com/docs/desktop/2/the-basics/power-monitor

Determines if the device is running on battery power or AC power. The example prints a comment in each branch of the if-else statement.

```php
use Native\Desktop\Facades\PowerMonitor;
 
if (PowerMonitor::isOnBatteryPower()) {
    // The device is running on battery power.
} else {
    // The device is running on AC power.
}

use Native\Desktop\Facades\PowerMonitor;

if (PowerMonitor::isOnBatteryPower()) {
    // The device is running on battery power.
} else {
    // The device is running on AC power.
}
```

--------------------------------

### Configure a menu item with chainable methods

Source: https://nativephp.com/docs/desktop/2/the-basics/application-menu

Demonstrates chaining methods on a Menu::route() item to set label, id, icon, visibility, tooltip (macOS only), hotkey, and disabled state.

```php
$item = Menu::route('welcome')
    ->label('Home')
    ->id('my-item')
    ->icon(public_path('path/to/icon.png'))
    ->visible(false)
    ->tooltip('Hover text FTW!') // macOS only
    ->hotkey('Cmd+F')
    ->disabled();
```

--------------------------------

### Run native:publish to build and upload artifacts

Source: https://nativephp.com/docs/desktop/2/publishing/publishing

Run `php artisan native:publish` to build for the current platform and architecture and upload artifacts to your chosen updater provider. Ensure the app version in your `.env` file is bumped before building.

```bash
php artisan native:publish
```

--------------------------------

### Window::open()->position()

Source: https://nativephp.com/docs/desktop/2/the-basics/windows

Specifies the initial position of the window.

```APIDOC
## Window::open()->position()

### Description
Specifies the initial position of the window.

### Method
`Window::open()->position($x, $y)`

### Parameters
- **$x** (int) - Required - The x-coordinate.
- **$y** (int) - Required - The y-coordinate.

### Example
```php
Window::open()
    ->position(100, 100);
```
```

--------------------------------

### MenuBar::create()->route('home')

Source: https://nativephp.com/docs/desktop/2/the-basics/menu-bar

Opens the specified route when the menu bar icon is clicked. By default, MenuBar::create() shows the root URL.

```php
MenuBar::create()
    ->route('home');
```
Tokens:
Raw