NativePHP Documentation

NativePHP for Mobile is a library that allows you to run full PHP applications natively on iOS and Android devices without requiring a web server. It works by embedding a pre-compiled PHP runtime alongside Laravel and bridging directly into platform-specific native APIs.

Key features include:

• Native Performance: Runs via an embedded PHP runtime optimized for each platform.
• True Native APIs: Access hardware like camera, biometrics, and push notifications via PHP.
• Laravel Powered: Uses the existing Laravel ecosystem.
• Offline-First: The app runs entirely on-device with no web server required.
• Cross-Platform: Single codebase for both iOS and Android.

The File API provides utilities for moving and copying files on a mobile device. Operations are synchronous and require absolute paths.

Important Requirements:

• Use absolute paths (e.g., via Laravel's storage_path() helper).
• The source file must exist.
• The destination directory must exist.
• If the destination file already exists, the operation will fail.
• Ensure your app has the necessary file system permissions for the target directories.

<?php
// PHP Import
use Native\
Mobile\
\Facades\
File;

// JS Import
import { file } from '#nativephp';

The Device API provides access to device hardware and information, including vibration, the flashlight, device identifiers, hardware specs, and battery status. It is a core built-in API, meaning it is available immediately without any additional installation or registration steps.

use Native\Mobile\Facades\Device;

NativePHP provides three shape primitives for drawing simple geometric forms. These are typically used inside a <native:canvas> or as standalone decorative accents.

Available primitives:

• <native:rect>: A rectangle filled with a bg color.
• <native:circle>: A circle filled with a bg color.
• <native:line>: A horizontal rule.

All shapes support shared layout and style attributes using Tailwind-style classes (e.g., rounded-*, border-*, opacity-*, shadow-*).

The Dialog API allows you to trigger native mobile UI elements such as alerts, toast notifications, and the system sharing interface. To use these features, import the Dialog facade:

use Native\	ext{Mobile}\\Facades\\Dialog;

use Native\Mobile\Facades\Dialog;

The Biometrics API allows you to authenticate users using their device's biometric sensors, such as Face ID, Touch ID, or fingerprint scanners. It supports both PHP and JavaScript interfaces.

use Native\/Mobile\/Facades\/Biometrics;

import { biometric, on, off, Events } from '#nativephp';

The Dialog API provides access to native platform dialogs (UIAlertController on iOS and AlertDialog on Android). It is a core built-in feature that requires no installation or registration. You can use it to show modal alerts with buttons or non-blocking toast/snackbar notifications.

Import the facade to begin:

use Native\	ext{Mobile}\\Facades\\Dialog;

use Native\Mobile\Facades\Dialog;

The PushNotifications API manages device registration with Firebase Cloud Messaging (FCM), allowing your mobile application to receive push notifications. You can access the API via the Native\Mobile\Facades\PushNotifications facade.

use Native\Mobile\Facades\PushNotifications;

The <native:button-group> is a segmented single-choice selector used for short, mutually-exclusive choices that fit on a single row. Each option appears as a pressable pill in a horizontal bar, with the active selection highlighted using theme.primary.

For more options or longer labels, consider using <native:tab-row> or <native:select> instead.

@php $period = 0; @endphp

<native:button-group :options="['Daily', 'Weekly', 'Monthly']" native:model="period" />

The File API provides access to native file system operations like moving and copying files directly on the device. It is a core built-in feature of NativePHP Mobile, meaning no additional installation or registration is required. You can access it via the Native\Mobile\Facades\File facade in PHP or via the Native library in a JavaScript web view.

use Native\Mobile\Facades\File;

The Chip component is a compact, capsule-shaped selectable tag. It features a boolean active state and an optional leading icon.

Visual States:

• Selected: Fills with theme.primary and uses theme.onPrimary for content.
• Unselected: Uses theme.surfaceVariant with a 1pt theme.outline stroke.

Styling: Colors are derived from the theme. The capsule is fully rounded by default, but you can adjust the radius using standard rounded-* utility classes.

@php $filterVerified = false; @endphp

<native:chip label="Verified" icon="check" native:model="filterVerified" />