NativePHP Laravel

https://github.com/nativephp/laravel
Admin
A Laravel wrapper for the NativePHP framework, enabling the creation of native desktop applications...
Tokens:174,876
Snippets:1,341
Trust Score:9.7
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Basic Theme and Timezone Example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/System.md

Shows how to get and set the system theme using SystemThemesEnum::DARK and retrieve the timezone with System::timezone().

```php
use Native\Laravel\Enums\SystemThemesEnum;
use Native\Laravel\Facades\System;

$current = System::theme();
System::theme(SystemThemesEnum::DARK);

Log::info('TZ: '.System::timezone());
```

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

### Basic Client usage example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Client.md

Directly instantiates Client and performs a GET request to 'process', reading the 'arch' key from the JSON response.

```php
use Native\Laravel\Client\Client;

$client = new Client;

$response = $client->get('process');
$arch = $response->json('arch');
```

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

### start

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ChildProcess.md

Starts a new child process with the given command and alias. Returns the hydrated ChildProcess.

```APIDOC
## POST child-process/start

### Description
Starts a new child process with the given command and alias. Returns the hydrated ChildProcess.

### Method
POST

### Endpoint
child-process/start

### Parameters
#### Request Body
- **cmd** (string|array) - Required - Command; a single string or array of argv parts.
- **alias** (string) - Required - Unique alias for the process.
- **cwd** (string) - Optional - Working directory. Defaults to `base_path()`.
- **env** (object) - Optional - Extra environment variables.
- **persistent** (boolean) - Optional - Keep the process alive / track state. Defaults to `false`.

### Request Example
{
  "cmd": "php artisan serve",
  "alias": "my-server",
  "cwd": "/var/www",
  "env": {"APP_ENV": "local"},
  "persistent": true
}

### Response
#### Success Response (200)
- **ChildProcess** (object) - The hydrated ChildProcess.

#### Response Example
{
  "alias": "my-server",
  "status": "running"
}
```

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

### ChildProcess::start()

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ChildProcess.md

Starts a new ChildProcess with the given command and options.

```APIDOC
## ChildProcess::start()

### Description
Starts a new ChildProcess with the given command and options.

### Method
Static method

### Signature
`static \Native\Laravel\ChildProcess start(string|array $cmd, string $alias, string $cwd = null, array $env = null, bool $persistent = false)`

### Parameters
- **$cmd** (string|array) - Required - The command to run.
- **$alias** (string) - Required - The alias for the process.
- **$cwd** (string) - Optional - The working directory.
- **$env** (array) - Optional - Environment variables.
- **$persistent** (bool) - Optional - Whether the process should persist.

### Return Value
- **\Native\Laravel\ChildProcess** - The ChildProcess instance.
```

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

### Basic Dock usage example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Dock.md

Sets a dock icon and badge label using the Dock facade.

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

Dock::icon(base_path('public/icon.png'));
Dock::badge('3');
```

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

### POST child-process/start

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Starts a new child process. Returns the process object.

```APIDOC
## POST child-process/start

### Description
Starts a new child process.

### Method
POST

### Endpoint
`child-process/start`

### Parameters
#### Request Body
- **alias** (string) - Required - Unique alias for the process.
- **cmd** (string) - Required - Command to run.
- **cwd** (string) - Optional - Working directory.
- **env** (object) - Optional - Environment variables.
- **persistent** (boolean) - Optional - Whether the process persists.

### Request Example
{
  "alias": "my-process",
  "cmd": "php artisan serve",
  "cwd": "/path/to/project",
  "env": { "APP_ENV": "production" },
  "persistent": true
}

### Response
#### Success Response (200)
- **process** (object) - The process object.

#### Response Example
{
  "process": { "pid": 1234, "alias": "my-process" }
}
```

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

### Basic Shell usage example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Shell.md

Reveals a downloaded report in the file manager and opens a support page in the browser.

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

$path = storage_path('exports/report.pdf');

Shell::showInFolder($path);
Shell::openExternal('https://nativephp.com');
```

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

### POST child-process/start-php

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Starts a PHP child process. Returns the process object.

```APIDOC
## POST child-process/start-php

### Description
Starts a PHP child process.

### Method
POST

### Endpoint
`child-process/start-php`

### Parameters
#### Request Body
- **alias** (string) - Required - Unique alias for the process.
- **cmd** (string) - Required - Command to run.
- **cwd** (string) - Optional - Working directory.
- **env** (object) - Optional - Environment variables.
- **persistent** (boolean) - Optional - Whether the process persists.
- **iniSettings** (object) - Optional - PHP ini settings.

### Request Example
{
  "alias": "my-php-process",
  "cmd": "php artisan serve",
  "cwd": "/path/to/project",
  "env": { "APP_ENV": "production" },
  "persistent": true,
  "iniSettings": { "memory_limit": "256M" }
}

### Response
#### Success Response (200)
- **process** (object) - The process object.

#### Response Example
{
  "process": { "pid": 1234, "alias": "my-php-process" }
}
```

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

### ChildProcess::php()

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ChildProcess.md

Starts a PHP process with the given arguments and options.

```APIDOC
## ChildProcess::php()

### Description
Starts a PHP process with the given arguments and options.

### Method
Static method

### Signature
`static \Native\Laravel\ChildProcess php(string|array $cmd, string $alias, array $env = null, bool $persistent = false)`

### Parameters
- **$cmd** (string|array) - Required - The PHP command arguments.
- **$alias** (string) - Required - The alias for the process.
- **$env** (array) - Optional - Environment variables.
- **$persistent** (bool) - Optional - Whether the process should persist.

### Return Value
- **\Native\Laravel\ChildProcess** - The ChildProcess instance.
```

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

### Basic platform check example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Process.md

Feature-check by platform using the Process facade. If the platform is 'darwin', a macOS-only path is executed.

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

if (Process::platform() === 'darwin') {
    // macOS-only path
}
```

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

### GET window/all

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves all open windows.

```APIDOC
## GET window/all

### Description
Retrieves all open windows.

### Method
GET

### Endpoint
`window/all`

### Response
#### Success Response
- **array of window objects** - List of all windows.

```

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

### Menu::default

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Menu.md

Installs the standard set of menus. This is a static method on the Menu facade.

```APIDOC
## Menu::default

### Description
Installs the standard set of menus.

### Method
Static method

### Signature
`static void default()`

### Parameters
None.

### Return Value
- **void** - No return value.

### Example
```php
Menu::default();
```
```

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

### Basic clipboard text example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Clipboard.md

Round-trip a text value: write to clipboard, then read it back.

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

Clipboard::text('Copied from my app');
$copied = Clipboard::text(); // 'Copied from my app'
```

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

### php

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ChildProcess.md

Starts a PHP child process with the given command and alias. Returns the hydrated ChildProcess.

```APIDOC
## POST child-process/start-php

### Description
Starts a PHP child process with the given command and alias. Returns the hydrated ChildProcess.

### Method
POST

### Endpoint
child-process/start-php

### Parameters
#### Request Body
- **cmd** (string|array) - Required - Command for a PHP process.
- **alias** (string) - Required - Process alias.
- **cwd** (string) - Optional - Working directory. Defaults to `base_path()`.
- **env** (object) - Optional - Extra environment variables.
- **persistent** (boolean) - Optional - Persistence flag. Defaults to `false`.
- **iniSettings** (object) - Optional - `php.ini` overrides applied to the child.

### Request Example
{
  "cmd": "artisan serve",
  "alias": "my-php",
  "cwd": "/var/www",
  "env": {"APP_ENV": "local"},
  "persistent": true,
  "iniSettings": {"memory_limit": "256M"}
}

### Response
#### Success Response (200)
- **ChildProcess** (object) - The hydrated ChildProcess.

#### Response Example
{
  "alias": "my-php",
  "status": "running"
}
```

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

### Basic open dialog example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Dialog.md

Opens a single image file with a filter and default path. Returns a string path or null.

```php
use Native\Laravel\Dialog;

$path = Dialog::new()
    ->title('Choose an image')
    ->filter('Images', ['png', 'jpg', 'gif'])
    ->defaultPath(base_path('pictures'))
    ->open();   // ?string — single selection result, or null
```

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

### Basic example: react to system idle

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/PowerMonitor.md

Checks if the system is idle after 300 seconds and pauses animations or reduces polling.

```php
use Native\Laravel\Enums\SystemIdleStatesEnum;
use Native\Laravel\Facades\PowerMonitor;

if (PowerMonitor::getSystemIdleState(300) === SystemIdleStatesEnum::IDLE) {
    // pause animations, reduce polling, etc.
}
```

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

### theme() method

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/System.md

Gets or sets the system color theme. When a theme is provided, it applies the theme; otherwise, it reads the current theme.

```php
public function theme(?SystemThemesEnum $theme = null): SystemThemesEnum
```

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

### ProgressBar::start()

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ProgressBar.md

Starts the progress bar by recording the current time and setting progress to 0. This initializes the progress indicator.

```APIDOC
## Method: start

### Description
Starts the progress bar by recording the current time and setting progress to 0.

### Method
start

### Signature
```php
public function start()
```

### Parameters
None

### Behavior
- Records `lastWriteTime = microtime(true)`
- Calls `setProgress(0)`

### Example
```php
$bar->start();
```
```

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

### Advanced Shell usage example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Shell.md

Opens a file only if it exists, checks the result, and then trashes it after review.

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

$path = storage_path('tmp/receipt.pdf');

if (file_exists($path)) {
    $result = Shell::openFile($path);   // string — runtime result

    if ($result !== 'ok') {
        Log::warning("open-item returned: {$result}");
    }
}

Shell::trashFile($path);   // move to OS trash
```

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

### Basic example: get center of active screen

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Screen.md

Uses the Screen facade to get the center of the active screen. The result is an array with x and y coordinates, e.g., ['x' => 640.0, 'y' => 360.0].

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

$center = Screen::getCenterOfActiveScreen();

// ['x' => 640.0, 'y' => 360.0]
```

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

### bootingPackage method

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/NativeServiceProvider.md

When running natively, calls rewriteDatabase() during boot.

```php
public function bootingPackage()
```

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

### Advanced example: enumerate displays and place window

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Screen.md

Enumerates displays and places a window on the primary display, using the Screen and Window facades. The window width and height are set to half the primary display's bounds.

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

$primary = Screen::primary();
$displays = Screen::displays();

Log::info('Primary display: '.json_encode($primary));

Window::open('main')
    ->width((int) $primary['bounds']['width'] / 2)
    ->height((int) $primary['bounds']['height'] / 2);
```

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

### ChildProcessFake assertion methods

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Fakes.md

Provides assertion methods for verifying calls to get, start, php, artisan, stop, restart, and message methods, each accepting a closure or alias to match against recorded calls.

```php
public function assertGet(string|Closure $alias): void
public function assertStarted(Closure $callback): void   // fn (cmd, alias, cwd, env, persistent): bool
public function assertPhp(Closure $callback): void
public function assertArtisan(Closure $callback): void
public function assertStop(string|Closure $alias): void
public function assertRestart(string|Closure $alias): void
public function assertMessage(Closure $callback): void   // fn (message, alias): bool
```

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

### ChildProcessFake class declaration and properties

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Fakes.md

Declares the ChildProcessFake class implementing the ChildProcess contract, with public arrays recording calls to get, start, php, artisan, stop, restart, and message methods.

```php
public class ChildProcessFake implements ChildProcessContract
public array $gets = [];          // array<int, string|null>
public array $starts = [];        // {cmd, alias, cwd, env, persistent}
public array $phps = [];          // {cmd, alias, env, persistent, iniSettings}
public array $artisans = [];      // {cmd, alias, env, persistent, iniSettings}
public array $stops = [];         // array<int, string|null>
public array $restarts = [];      // array<int, string|null>
public array $messages = [];      // {message, alias}
```

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

### Basic ChildProcess Usage with Event Listener

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ChildProcess.md

Starts a long-running PHP process and subscribes to its output via the MessageReceived event. The example uses ChildProcess::php() with persistent: true and logs messages when the alias matches 'worker'.

```php
use Illuminate\Support\Facades\Event;
use Native\Laravel\Events\ChildProcess\MessageReceived;
use Native\Laravel\Facades\ChildProcess;

Event::listen(MessageReceived::class, function (MessageReceived $e) {
    if ($e->alias === 'worker') {
        Log::info($e->data);
    }
});

$process = ChildProcess::php(['-S', 'worker.php'], 'worker', persistent: true);
```

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

### ChildProcess Facade Static Method Signatures

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ChildProcess.md

Lists the static methods exposed by the ChildProcess facade, including all(), get(), message(), restart(), start(), php(), artisan(), and stop(). The accessor clears the resolved instance so a swapped fake is picked up.

```php
static \Native\Laravel\ChildProcess[] all()
static \Native\Laravel\ChildProcess|null get(string $alias = null)
static \Native\Laravel\ChildProcess message(string $message, string $alias = null)
static \Native\Laravel\ChildProcess restart(string $alias = null)
static \Native\Laravel\ChildProcess start(string|array $cmd, string $alias, string $cwd = null, array $env = null, bool $persistent = false)
static \Native\Laravel\ChildProcess php(string|array $cmd, string $alias, array $env = null, bool $persistent = false)
static \Native\Laravel\ChildProcess artisan(string|array $cmd, string $alias, array $env = null, bool $persistent = false)
static void stop(string $alias = null)
```

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

### artisan

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ChildProcess.md

Starts an artisan command as a PHP child process. Prepends 'artisan' to the command and delegates to php(). Returns the hydrated ChildProcess.

```APIDOC
## POST child-process/start-php (artisan)

### Description
Starts an artisan command as a PHP child process. Prepends 'artisan' to the command and delegates to php(). Returns the hydrated ChildProcess.

### Method
POST

### Endpoint
child-process/start-php

### Parameters
#### Request Body
- **cmd** (string|array) - Required - Command for an artisan process (without 'artisan' prefix).
- **alias** (string) - Required - Process alias.
- **cwd** (string) - Optional - Working directory. Defaults to `base_path()`.
- **env** (object) - Optional - Extra environment variables.
- **persistent** (boolean) - Optional - Persistence flag. Defaults to `false`.
- **iniSettings** (object) - Optional - `php.ini` overrides applied to the child.

### Request Example
{
  "cmd": "migrate",
  "alias": "my-artisan",
  "cwd": "/var/www",
  "env": {"APP_ENV": "local"},
  "persistent": true,
  "iniSettings": {"memory_limit": "256M"}
}

### Response
#### Success Response (200)
- **ChildProcess** (object) - The hydrated ChildProcess.

#### Response Example
{
  "alias": "my-artisan",
  "status": "running"
}
```

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

### Client get method

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Client.md

Sends a GET request to the specified endpoint with optional query parameters. Returns Illuminate\Http\Client\Response.

```php
public function get(string $endpoint, array|string|null $query = null): Response
```

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

### Settings facade methods

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Settings.md

Facade forwards to the Settings class, providing static methods for set, get, forget, and clear.

```php
static void set(string $key, $value)
static mixed get(string $key, $default = null)
static void forget(string $key)
static void clear()
```

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

### Start worker from config-array name

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/QueueWorker.md

Basic usage: starts a worker by referencing the alias defined in config/nativephp.php under 'queue_workers'. The alias must exist in the configuration array.

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

// config/nativephp.php defines 'queue_workers' => ['default' => [...]]:
QueueWorker::up('default');
```

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

### help

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Menu.md

Creates a menu item that opens the help menu.

```APIDOC
## help

### Description
Creates a menu item that opens the help menu.

### Method
help

### Parameters
- **label** (?string) - Optional - The label for the menu item.

### Returns
- **Items\Role** - The created role menu item.
```

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

### openAtLogin(?bool $open = null)

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/App.md

Gets or sets whether the app opens at login. When $open is null, reads the 'open' value from 'app/open-at-login' via HTTP GET; otherwise posts the value via HTTP POST.

```APIDOC
## openAtLogin(?bool $open = null)

### Description
Gets or sets whether the app opens at login. When $open is null, reads the 'open' value from 'app/open-at-login' via HTTP GET; otherwise posts the value via HTTP POST.

### Method
GET or POST

### Endpoint
app/open-at-login

### Parameters
#### Query Parameters
- **open** (bool|null) - Optional - When provided, sets the open-at-login flag. When null, fetches the current value.

### Request Example (when setting)
{
  "open": true
}

### Response
#### Success Response (200)
- **open** (boolean) - The current open-at-login flag (when GET).

#### Response Example (when GET)
{
  "open": true
}
```

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

### Window::__construct

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Window.md

Creates a new Window instance with the given ID, initializing default title, URL, and dev tools settings from the application configuration.

```APIDOC
## Window::__construct

### Description
Creates a new Window instance with the given ID, initializing default title, URL, and dev tools settings from the application configuration.

### Method
Constructor

### Signature
```php
public function __construct(string $id)
```

### Parameters
- **$id** (string) - Required - The window ID.

### Behavior
Sets `$this->id = $id`, `title = config('app.name')`, `url = url('/')`, `showDevTools = config('app.debug')`.
```

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

### badgeCount($count = null)

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/App.md

Gets or sets the dock badge count. When $count is null, fetches the current count from 'app/badge-count' via HTTP GET; otherwise sets it via HTTP POST with the count in the request body.

```APIDOC
## badgeCount($count = null)

### Description
Gets or sets the dock badge count. When $count is null, fetches the current count from 'app/badge-count' via HTTP GET; otherwise sets it via HTTP POST with the count in the request body.

### Method
GET or POST

### Endpoint
app/badge-count

### Parameters
#### Query Parameters
- **count** (int|null) - Optional - When provided, sets the badge count. When null, fetches the current count.

### Request Example (when setting)
{
  "count": 5
}

### Response
#### Success Response (200)
- **count** (int) - The current badge count (when GET).

#### Response Example (when GET)
{
  "count": 5
}
```

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

### Start and stop worker with explicit QueueConfig

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/QueueWorker.md

Advanced usage: creates a QueueConfig with alias 'reports', queues ['reports', 'default'], memory 256, timeout 120, sleep 5. Starts the worker, then later stops it by alias, which terminates the 'queue_reports' child process.

```php
use Native\Laravel\DTOs\QueueConfig;
use Native\Laravel\Facades\QueueWorker;

$config = new QueueConfig('reports', ['reports', 'default'], 256, 120, 5);

QueueWorker::up($config);

// later:
QueueWorker::down('reports');   // stops 'queue_reports'
```

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

### Advanced Print to PDF or Default Printer Example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/System.md

Demonstrates printing an HTML report to the default printer or to a PDF file, with error handling for runtime print job failures.

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

$html = '<h1>Quarterly report</h1>';

try {
    if ($asPdf) {
        $pdf = System::printToPDF($html, ['pageSize' => 'A4']);
        Shell::showInFolder($pdf);
    } else {
        System::print($html);   // default printer
    }
} catch (\Throwable $e) {
    // runtime print job failed
    Log::error($e->getMessage());
}
```

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

### get(string $key, $default = null): mixed

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Settings.md

Retrieves the value for a given settings key. Sends a GET request to the runtime endpoint `settings/{key}` and returns the value from the JSON response. If the stored value is null, returns the default (invoking it if it's a Closure).

```APIDOC
## [GET] settings/{key}

### Description
Retrieves the value for a given settings key.

### Method
GET

### Endpoint
settings/{key}

### Parameters
#### Path Parameters
- **key** (string) - Required - Settings key.

#### Query Parameters
- **default** (mixed) - Optional - Fallback value. If a Closure, it is invoked to produce the fallback.

### Response
#### Success Response (200)
- **value** (mixed) - The stored value. If null, returns the default.

#### Response Example
{
  "value": "dark"
}

```

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

### Example: Window fake with forced return and open

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Fakes.md

Fakes the Window facade, forces a Window instance for 'main', opens it, and sets its title. Demonstrates using alwaysReturnWindows with open().

```php
Window::fake()
    ->alwaysReturnWindows([(new WindowClass('main'))->setClient(new Client)]);

$window = Window::open('main');
$window->title('Loaded');
```

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

### Advanced process descriptor example

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Process.md

Inspect the full process descriptor and compute a custom metric using Process::fresh(). Logs arch, platform, and uptime.

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

$info = Process::fresh();   // object with arch, platform, uptime

Log::info([
    'arch' => $info->arch,
    'platform' => $info->platform,
    'uptime' => $info->uptime,
]);
```

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

### GET system/can-encrypt

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Checks if encryption is available.

```APIDOC
## GET system/can-encrypt

### Description
Checks if encryption is available.

### Method
GET

### Endpoint
`system/can-encrypt`

### Response
#### Success Response
- **result** - Boolean indicating if encryption is available.

```

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

### focus()

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/App.md

Brings all windows to the front. Issues a synchronous HTTP POST to the runtime endpoint 'app/focus'.

```APIDOC
## focus()

### Description
Brings all windows to the front. Issues a synchronous HTTP POST to the runtime endpoint 'app/focus'.

### Method
POST

### Endpoint
app/focus

### Parameters
None

### Response
#### Success Response (200)
No return value (void).
```

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

### GET window/get/{id}

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves a window by ID.

```APIDOC
## GET window/get/{id}

### Description
Retrieves a window by ID.

### Method
GET

### Endpoint
`window/get/{id}`

### Path Parameters
- **id** (string) - Required - The window ID.

### Response
#### Success Response
- **window object** - The window object.

```

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

### GET window/current

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the current window object.

```APIDOC
## GET window/current

### Description
Retrieves the current window object.

### Method
GET

### Endpoint
`window/current`

### Response
#### Success Response
- **window object** - The current window object.

```

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

### Basic window opening with Window::open()

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Window.md

Opens a window from the app provider using the Window facade. Configures window properties like title, dimensions, and minimum size, and enables state remembering. The afterOpen callback logs when the window is opened.

```php
namespace App\Providers;

use Native\Laravel\Facades\Window;

class NativeAppServiceProvider
{
    public function boot(): void
    {
        Window::open()
            ->id('main')
            ->title('My App')
            ->width(1024)
            ->height(768)
            ->minWidth(640)
            ->minHeight(480)
            ->rememberState()
            ->afterOpen(fn () => Log::info('Main window opened'));
    }
}
```

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

### MenuBar::__construct

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/MenuBar.md

Creates a new MenuBar builder instance. Sets the default URL to the root path.

```APIDOC
## MenuBar::__construct

### Description
Creates a new MenuBar builder instance. Sets the default URL to the root path.

### Method
Constructor

### Signature
```php
public function __construct()
```

### Parameters
None

### Return Value
- **void** - No return value.
```

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

### GET system/theme

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the current system theme.

```APIDOC
## GET system/theme

### Description
Retrieves the current system theme.

### Method
GET

### Endpoint
`system/theme`

### Response
#### Success Response
- **result** - The current theme.

```

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

### Window::webPreferences

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Window.md

Sets web preferences as a raw array.

```APIDOC
## Window::webPreferences

### Description
Sets web preferences as a raw array.

### Method
Method

### Signature
```php
public function webPreferences(array $preferences): static
```

### Parameters
- **$preferences** (array) - Required - The web preferences array.

### Returns
`static` - The current instance.
```

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

### GET system/printers

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves a list of available printers.

```APIDOC
## GET system/printers

### Description
Retrieves a list of available printers.

### Method
GET

### Endpoint
`system/printers`

### Response
#### Success Response
- **printers** - Array of printer objects.

```

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

### GET screen/active

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the active screen bounds.

```APIDOC
## GET screen/active

### Description
Retrieves the active screen bounds.

### Method
GET

### Endpoint
`screen/active`

### Response
#### Success Response
- **bounds** - The bounds of the active screen.

```

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

### GET screen/primary-display

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves information about the primary display.

```APIDOC
## GET screen/primary-display

### Description
Retrieves information about the primary display.

### Method
GET

### Endpoint
`screen/primary-display`

### Response
#### Success Response
- **primaryDisplay** - The primary display object.

```

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

### GET screen/displays

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves information about all connected displays.

```APIDOC
## GET screen/displays

### Description
Retrieves information about all connected displays.

### Method
GET

### Endpoint
`screen/displays`

### Response
#### Success Response
- **displays** - Array of display objects.

```

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

### Window::showDevTools

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Window.md

Shows the developer tools. If the window is not pending, it immediately posts the update to the runtime.

```APIDOC
## Window::showDevTools

### Description
Shows the developer tools. If the window is not pending, it immediately posts the update to the runtime.

### Method
Method

### Signature
```php
public function showDevTools(bool $showDevTools = true): self
```

### Parameters
- **$showDevTools** (bool) - Optional - Whether to show dev tools. Defaults to `true`.

### Returns
`self` - The current instance.

### Behavior
If the instance is not a `PendingOpenWindow`, it sends a POST request to `window/show-dev-tools`.
```

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

### isOnBatteryPower method

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/PowerMonitor.md

Returns boolean battery status via GET power-monitor/is-on-battery-power.

```php
public function isOnBatteryPower(): bool
```

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

### POST auto-updater/quit-and-install

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Quits the app and installs the update.

```APIDOC
## POST auto-updater/quit-and-install

### Description
Quits the app and installs the update.

### Method
POST

### Endpoint
`auto-updater/quit-and-install`

### Parameters
None

### Request Example
No request body

### Response
No response body
```

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

### about

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Menu.md

Creates a menu item that shows the about dialog.

```APIDOC
## about

### Description
Creates a menu item that shows the about dialog.

### Method
about

### Parameters
- **label** (?string) - Optional - The label for the menu item.

### Returns
- **Items\Role** - The created role menu item.
```

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

### Basic menu bar creation with context menu

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/MenuBar.md

Creates a menu bar with an icon, label, tooltip, size, and a context menu. Uses MenuBar::create() and Menu::make() to define menu items that trigger events.

```php
use Native\Laravel\Facades\Menu;
use Native\Laravel\Facades\MenuBar;

MenuBar::create()
    ->icon(base_path('public/tray.png'))
    ->label('My App')
    ->tooltip('My App tray menu')
    ->width(360)
    ->height(240)
    ->onlyShowContextMenu()
    ->withContextMenu(Menu::make(
        Menu::label('Show Window')->event('window:show'),
        Menu::label('Quit')->event('app:quit'),
    ));
```

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

### GET system/can-prompt-touch-id

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Checks if Touch ID prompt is available.

```APIDOC
## GET system/can-prompt-touch-id

### Description
Checks if Touch ID prompt is available.

### Method
GET

### Endpoint
`system/can-prompt-touch-id`

### Response
#### Success Response
- **result** - Boolean indicating if Touch ID prompt is available.

```

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

### Window Facade Methods

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Window.md

Static methods provided by the `Native\Laravel\Facades\Window` facade for managing windows. Note that some methods listed in the doc-block are not implemented in the underlying `WindowManager` and will fail at runtime.

```APIDOC
## Window Facade Methods

### Description
Static methods provided by the `Native\Laravel\Facades\Window` facade for managing windows. Note that some methods listed in the doc-block are not implemented in the underlying `WindowManager` and will fail at runtime.

### Methods

#### `fake()`
- **Signature**: `public static function fake()`
- **Description**: Swaps the facade's resolved instance to `Native\Laravel\Fakes\WindowManagerFake`.

#### `open()`
- **Signature**: `static \Native\Laravel\Windows\PendingOpenWindow open(string $id = 'main')`
- **Description**: Opens a new window with the given ID.

#### `close()`
- **Signature**: `static void close($id = null)`
- **Description**: Closes the specified window (or the current one if no ID is given).

#### `current()`
- **Signature**: `static object current()`
- **Description**: Returns the current window object.

#### `all()`
- **Signature**: `static array all()`
- **Description**: Returns an array of all open windows.

#### `resize()`
- **Signature**: `static void resize($width, $height, $id = null)`
- **Description**: Resizes the specified window (or the current one) to the given dimensions.

#### `position()`
- **Signature**: `static void position($x, $y, $animated = false, $id = null)`
- **Description**: Moves the specified window (or the current one) to the given coordinates.

#### `alwaysOnTop()`
- **Signature**: `static void alwaysOnTop($alwaysOnTop = true, $id = null)`
- **Description**: Sets whether the specified window (or the current one) should always stay on top.

#### `reload()`
- **Signature**: `static void reload($id = null)`
- **Description**: Reloads the specified window (or the current one).

#### `maximize()`
- **Signature**: `static void maximize($id = null)`
- **Description**: Maximizes the specified window (or the current one).

#### `minimize()`
- **Signature**: `static void minimize($id = null)`
- **Description**: Minimizes the specified window (or the current one).

#### `zoomFactor()`
- **Signature**: `static void zoomFactor(float $zoomFactor = 1.0)`
- **Description**: Sets the zoom factor for the window. **Note**: Not implemented in `WindowManager`; calling this will fail at runtime.

#### `preventLeaveDomain()`
- **Signature**: `static void preventLeaveDomain(bool $preventLeaveDomain = true)`
- **Description**: Prevents the window from leaving the domain. **Note**: Not implemented in `WindowManager`; calling this will fail at runtime.

#### `preventLeavePage()`
- **Signature**: `static void preventLeavePage(bool $preventLeavePage = true): self`
- **Description**: Prevents the window from leaving the page. **Note**: Not implemented in `WindowManager`; calling this will fail at runtime.

#### `suppressNewWindows()`
- **Signature**: `static void suppressNewWindows()`
- **Description**: Suppresses new windows. **Note**: Not implemented in `WindowManager`; calling this will fail at runtime.

### Note
- The facade doc-block lists `zoomFactor`, `preventLeaveDomain`, `preventLeavePage`, `suppressNewWindows` as static methods, but the bound `WindowManager` implementation does **not** define those methods — calling them through the facade fails at runtime.
- The static surface implemented by `WindowManager` is: `open`, `close`, `hide`, `show`, `current`, `all`, `get`, `resize`, `position`, `alwaysOnTop`, `maximize`, `minimize`, `reload`.
```

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

### GET screen/cursor-position

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the current cursor position on the screen.

```APIDOC
## GET screen/cursor-position

### Description
Retrieves the current cursor position on the screen.

### Method
GET

### Endpoint
`screen/cursor-position`

### Response
#### Success Response
- **raw** - The raw cursor position data.

```

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

### POST dock/show

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Shows the dock.

```APIDOC
## POST dock/show

### Description
Shows the dock.

### Method
POST

### Endpoint
`dock/show`

### Parameters
None

### Request Example
No request body

### Response
No response body
```

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

### GET power-monitor/is-on-battery-power

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Checks if the device is currently on battery power.

```APIDOC
## GET power-monitor/is-on-battery-power

### Description
Checks if the device is currently on battery power.

### Method
GET

### Endpoint
`power-monitor/is-on-battery-power`

### Response
#### Success Response
- **result** - Boolean indicating if on battery power.

```

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

### getCurrentThermalState method

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/PowerMonitor.md

Returns ThermalStatesEnum via GET power-monitor/get-current-thermal-state, falling back to UNKNOWN.

```php
public function getCurrentThermalState(): ThermalStatesEnum
```

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

### printToPDF() method

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/System.md

Renders HTML to a PDF and returns the result as a string (path or data).

```php
public function printToPDF(string $html, ?array $settings = []): string
```

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

### ChildProcess::artisan()

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ChildProcess.md

Starts an Artisan command as a child process with the given arguments and options.

```APIDOC
## ChildProcess::artisan()

### Description
Starts an Artisan command as a child process with the given arguments and options.

### Method
Static method

### Signature
`static \Native\Laravel\ChildProcess artisan(string|array $cmd, string $alias, array $env = null, bool $persistent = false)`

### Parameters
- **$cmd** (string|array) - Required - The Artisan command arguments.
- **$alias** (string) - Required - The alias for the process.
- **$env** (array) - Optional - Environment variables.
- **$persistent** (bool) - Optional - Whether the process should persist.

### Return Value
- **\Native\Laravel\ChildProcess** - The ChildProcess instance.
```

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

### Basic App Facade Usage

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/App.md

Shows how to query and mutate app state through the facade, including getting version, checking hidden status, adding a recent document, and focusing the app.

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

$version = App::version();
$hidden  = App::isHidden();

App::addRecentDocument('/path/to/project/docs.txt');
App::focus();
```

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

### GET settings/{key}

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the value of a setting for the given key.

```APIDOC
## GET settings/{key}

### Description
Retrieves the value of a setting for the given key.

### Method
GET

### Endpoint
`settings/{key}`

### Path Parameters
- **key** (string) - Required - The setting key.

### Response
#### Success Response
- **value** - The setting value.

```

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

### GET power-monitor/get-current-thermal-state

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the current thermal state of the power monitor.

```APIDOC
## GET power-monitor/get-current-thermal-state

### Description
Retrieves the current thermal state of the power monitor.

### Method
GET

### Endpoint
`power-monitor/get-current-thermal-state`

### Response
#### Success Response
- **result** - The current thermal state.

```

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

### GET dock/badge

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the dock badge. Returns the raw response.

```APIDOC
## GET dock/badge

### Description
Retrieves the dock badge.

### Method
GET

### Endpoint
`dock/badge`

### Parameters
None

### Request Example
No request body

### Response
#### Success Response (200)
- **raw** (string) - The raw response.

#### Response Example
{
  "raw": "badge"
}
```

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

### ProgressBar::start method

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/ProgressBar.md

Records the last write time and calls setProgress(0) to initialize the progress indicator.

```php
public function start()
```

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

### GET clipboard/html

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the clipboard HTML. Returns the HTML string.

```APIDOC
## GET clipboard/html

### Description
Retrieves the clipboard HTML.

### Method
GET

### Endpoint
`clipboard/html`

### Parameters
None

### Request Example
No request body

### Response
#### Success Response (200)
- **html** (string) - The clipboard HTML.

#### Response Example
{
  "html": "<p>Hello</p>"
}
```

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

### window

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Menu.md

Creates a window menu role with an optional label.

```APIDOC
## window

### Description
Creates a window menu role with an optional label.

### Method
window

### Parameters
- **label** (?string) - Optional - The label for the menu item.

### Returns
- **Items\Role** - The created role menu item.
```

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

### GET clipboard/text

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the clipboard text. Returns the text string.

```APIDOC
## GET clipboard/text

### Description
Retrieves the clipboard text.

### Method
GET

### Endpoint
`clipboard/text`

### Parameters
None

### Request Example
No request body

### Response
#### Success Response (200)
- **text** (string) - The clipboard text.

#### Response Example
{
  "text": "Hello"
}
```

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

### show()

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Dock.md

Shows the dock icon. Sends a POST request to the 'dock/show' endpoint.

```APIDOC
## show()

### Description
Shows the dock icon. Sends a POST request to the 'dock/show' endpoint.

### Method
POST

### Endpoint
dock/show

### Parameters
None

### Response
No response body specified.
```

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

### GET app/is-emoji-panel-supported

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Checks if the emoji panel is supported. Returns a boolean.

```APIDOC
## GET app/is-emoji-panel-supported

### Description
Checks if the emoji panel is supported.

### Method
GET

### Endpoint
`app/is-emoji-panel-supported`

### Parameters
None

### Request Example
No request body

### Response
#### Success Response (200)
- **supported** (boolean) - Whether the emoji panel is supported.

#### Response Example
{
  "supported": true
}
```

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

### Window::setClient

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Window.md

Attaches an HTTP client to the window instance.

```APIDOC
## Window::setClient

### Description
Attaches an HTTP client to the window instance.

### Method
Method

### Signature
```php
public function setClient(Client $client): self
```

### Parameters
- **$client** (Client) - Required - The HTTP client to attach.

### Returns
`self` - The current instance.
```

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

### Bundling and login methods

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/App.md

Methods to check if running bundled and to get/set open at login.

```php
public function isRunningBundled(): bool
public function openAtLogin(?bool $open = null): bool
```

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

### GET app/open-at-login

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Checks if the app opens at login. Returns a boolean.

```APIDOC
## GET app/open-at-login

### Description
Checks if the app opens at login.

### Method
GET

### Endpoint
`app/open-at-login`

### Parameters
None

### Request Example
No request body

### Response
#### Success Response (200)
- **open** (boolean) - Whether the app opens at login.

#### Response Example
{
  "open": true
}
```

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

### file

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Menu.md

Creates a file menu role with an optional label.

```APIDOC
## file

### Description
Creates a file menu role with an optional label.

### Method
file

### Parameters
- **label** (?string) - Optional - The label for the menu item.

### Returns
- **Items\Role** - The created role menu item.
```

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

### GET app/version

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/endpoints.md

Retrieves the application version. Returns the version string.

```APIDOC
## GET app/version

### Description
Retrieves the application version.

### Method
GET

### Endpoint
`app/version`

### Parameters
None

### Request Example
No request body

### Response
#### Success Response (200)
- **version** (string) - The application version.

#### Response Example
{
  "version": "1.0.0"
}
```

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

### label

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/Menu.md

Creates a label menu item with an optional hotkey.

```APIDOC
## label

### Description
Creates a label menu item with an optional hotkey.

### Method
label

### Parameters
- **label** (string) - Required - The text to display for the menu item.
- **hotkey** (?string) - Optional - The keyboard shortcut for the menu item.

### Returns
- **Items\Label** - The created label menu item.
```

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

### getSystemIdleTime method

Source: https://github.com/nativephp/laravel/blob/main/_autodocs/api-reference/PowerMonitor.md

Returns seconds since last user input via GET power-monitor/get-system-idle-time.

```php
public function getSystemIdleTime(): int
```
Tokens:
Raw