Skip to content

πŸ“š Mobile v1.1 Documentation Updates #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Jul 13, 2025
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
593fde1
Updates some of the docs for mobile
shanerbaner82 Jun 1, 2025
9fefd45
Updates ordering for docs
shanerbaner82 Jun 1, 2025
e6d3fa0
Merge branch 'main' into docs-updates
shanerbaner82 Jun 15, 2025
a699a30
updates doc
shanerbaner82 Jun 15, 2025
bdcac7b
πŸ“š Update mobile v1.1 documentation structure and content
shanerbaner82 Jul 7, 2025
6783490
Resolve merge conflicts with main branch
shanerbaner82 Jul 7, 2025
c364c16
Merge remote-tracking branch 'origin/main' into v1.1-docs-updates
shanerbaner82 Jul 7, 2025
cd6f1d0
Update resources/views/docs/mobile/1/apis/camera.md
shanerbaner82 Jul 7, 2025
1c0ad47
More docs updates
shanerbaner82 Jul 8, 2025
033fd97
Update mobile documentation with enhanced deep links, push notificati…
shanerbaner82 Jul 9, 2025
69832bf
Update Dialog API documentation for new alert implementation
shanerbaner82 Jul 10, 2025
4ba3bdc
Add Browser API documentation for in-app browser functionality
shanerbaner82 Jul 10, 2025
36c6d88
Update resources/views/docs/mobile/1/the-basics/icu-support.md
shanerbaner82 Jul 10, 2025
df3c84a
Update resources/views/docs/mobile/1/apis/browser.md
shanerbaner82 Jul 10, 2025
90ae4c3
Update mobile documentation with API improvements and platform notes
shanerbaner82 Jul 10, 2025
14bbdf7
Simplify versioning documentation with Laravel-inspired approach
shanerbaner82 Jul 10, 2025
0c7714c
Update Browser API documentation with new methods and improved structure
shanerbaner82 Jul 10, 2025
639ec1d
polish (#182)
simonhamp Jul 13, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions app/Http/Controllers/ShowDocumentationController.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ public function __invoke(Request $request, string $platform, string $version, ?s
} catch (InvalidArgumentException $e) {
return $this->redirectToFirstNavigationPage($navigation, $page);
}

SEOTools::setTitle($pageProperties['title'].' - NativePHP '.$platform.' v'.$version);
SEOTools::setDescription(Arr::exists($pageProperties, 'description') ? $pageProperties['description'] : '');

Expand All @@ -65,7 +64,8 @@ protected function getPageProperties($platform, $version, $page = null): array
$pageProperties = $document->matter();

$versionProperties = YamlFrontMatter::parseFile(resource_path("views/docs/{$platform}/{$version}/_index.md"));
$pageProperties = array_merge($pageProperties, $versionProperties->matter());

$pageProperties = array_merge($versionProperties->matter(), $pageProperties);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessarily an issue but can you help me understand why the order of arguments were switched here? Was something being overwritten we wasn't expecting? πŸ‘€

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually yeah, and maybe you can verify, locally for me every page showed "Mobile" as the title of the document, reversing this fixed it for me. On the website currently it works fine now, not sure what's going on tbh and I didn't switch it back.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On my end I see the title NativePHP on every page. Looks like the title tag is present in the head twice.

By editing $pageProperties the second title tag does change, but my browser only picks up the first one so I can't see it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might depend on your cache driver, I haven't played with it but saw some code about cacheing if local...


$pageProperties['platform'] = $platform;
$pageProperties['version'] = $version;
Expand Down
99 changes: 99 additions & 0 deletions resources/views/docs/mobile/1/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
title: Mobile
order: 1
---

# NativePHP for Mobile

**Build native iOS and Android apps with PHP and Laravel**

NativePHP for Mobile revolutionizes mobile development by allowing PHP developers to create native mobile applications using the languages and frameworks they already know and love. No need to learn Swift, Kotlin, or React Native - just pure PHP and Laravel.

## What Makes NativePHP Mobile Special?

=οΏ½ **Native Performance** - Your app runs natively on device with embedded PHP runtime
=οΏ½ **True Mobile APIs** - Access camera, biometrics, push notifications, and more
οΏ½ **Laravel Powered** - Use your existing Laravel skills and ecosystem
=' **No Web Server** - Your app runs entirely on-device
<οΏ½ **Cross Platform** - Single codebase for iOS and Android

## Quick Start

Get your first mobile app running in minutes:

```bash
# Install NativePHP Mobile
composer require nativephp/mobile

# Configure your app
php artisan native:install

# Run your app
php artisan native:run
```

## Current Features (v1.1)

**Available now:**
- =οΏ½ Camera & Gallery access
- = Biometric authentication (Face ID, Touch ID, Fingerprint)
- = Push notifications via Firebase
- =οΏ½ Native dialogs & toasts
- = Deep links & universal links
- =οΏ½ NFC support
- =οΏ½ Haptic feedback & vibration
- =& Flashlight control
- =οΏ½ Native sharing
- = Secure storage (Keychain/Keystore)
- =οΏ½ Location services

[See the complete roadmap οΏ½](/docs/mobile/1/getting-started/roadmap)

## Documentation Sections

### [Getting Started](/docs/mobile/1/getting-started)
Everything you need to start building mobile apps with PHP:
- [Introduction](/docs/mobile/1/getting-started/introduction) - Learn how NativePHP Mobile works
- [Installation](/docs/mobile/1/getting-started/installation) - Set up your development environment
- [Environment Setup](/docs/mobile/1/getting-started/environment-setup) - Configure iOS and Android tools
- [Configuration](/docs/mobile/1/getting-started/configuration) - App settings and permissions
- [Development](/docs/mobile/1/getting-started/development) - Development workflow
- [Roadmap](/docs/mobile/1/getting-started/roadmap) - Current and planned features

### [The Basics](/docs/mobile/1/the-basics)
Core concepts and fundamental knowledge:
- [Native Functions](/docs/mobile/1/the-basics/native-functions) - Understanding sync vs async APIs
- [Asynchronous Methods](/docs/mobile/1/the-basics/asynchronous-methods) - Event-driven mobile development
- [ICU Support](/docs/mobile/1/the-basics/icu-support) - International components for Unicode

### [Concepts](/docs/mobile/1/concepts)
Important concepts for mobile app development:
- [CI/CD](/docs/mobile/1/concepts/ci-cd) - Continuous integration and deployment
- [Deep Links](/docs/mobile/1/concepts/deep-links) - Universal links, app links, and NFC
- [Push Notifications](/docs/mobile/1/concepts/push-notifications) - Firebase Cloud Messaging setup
- [Splash Screen/Icons](/docs/mobile/1/concepts/splash-screen-icons) - App branding and assets
- [Versioning](/docs/mobile/1/concepts/versioning) - App version management

### [APIs](/docs/mobile/1/apis)
Complete API reference for all native features:
- [Biometrics](/docs/mobile/1/apis/biometrics) - Face ID, Touch ID, fingerprint authentication
- [Camera](/docs/mobile/1/apis/camera) - Photo capture and gallery access
- [Dialog](/docs/mobile/1/apis/dialog) - Alerts, toasts, and sharing
- [Geolocation](/docs/mobile/1/apis/geolocation) - GPS and location services
- [Haptics](/docs/mobile/1/apis/haptics) - Vibration and tactile feedback
- [PushNotifications](/docs/mobile/1/apis/push-notifications) - FCM token management
- [SecureStorage](/docs/mobile/1/apis/secure-storage) - Keychain and keystore operations
- [System](/docs/mobile/1/apis/system) - Flashlight and legacy methods

### [Digging Deeper](/docs/mobile/1/digging-deeper)
Advanced topics for production apps:
- [Databases](/docs/mobile/1/digging-deeper/databases) - SQLite and data management
- [Security](/docs/mobile/1/digging-deeper/security) - Best practices and secure storage

## Need Help?

- **License Required** - [Purchase your license](https://nativephp.com/mobile) to get started
- **Community** - Join our Discord for support and discussions
- **Examples** - Check out the Kitchen Sink demo app (coming soon to app stores)

Ready to build your first mobile app with PHP? [Let's get started! οΏ½](/docs/mobile/1/getting-started/introduction)
140 changes: 140 additions & 0 deletions resources/views/docs/mobile/1/apis/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
---
title: APIs
order: 4
---

# API Reference

Complete documentation for all NativePHP Mobile APIs. Each API provides access to native device capabilities through familiar PHP facades.

## Available APIs

### [Biometrics](/docs/mobile/1/apis/biometrics)
**Face ID, Touch ID, Fingerprint Authentication**
```php
Biometrics::promptForBiometricID();
```
Secure user authentication using device biometric sensors. Supports Face ID on iOS, Touch ID, and fingerprint readers on Android.

### [Camera](/docs/mobile/1/apis/camera)
**Photo Capture & Gallery Access**
```php
Camera::getPhoto();
Camera::pickImages('images', true, 5);
```
Take photos with the device camera or select images from the photo gallery. Supports both single and multiple image selection.

### [Dialog](/docs/mobile/1/apis/dialog)
**Native UI Elements**
```php
Dialog::alert('Title', 'Message', $buttons, $callback);
Dialog::toast('Success message');
Dialog::share('Title', 'Text', 'https://example.com');
```
Display native alerts, toast notifications, and sharing interfaces that match platform design guidelines.

### [Geolocation](/docs/mobile/1/apis/geolocation) ⭐ New in v1.1
**GPS & Location Services**
```php
Geolocation::getCurrentPosition(true); // High accuracy
Geolocation::checkPermissions();
Geolocation::requestPermissions();
```
Access device location services with configurable accuracy levels and proper permission handling.

### [Haptics](/docs/mobile/1/apis/haptics)
**Vibration & Tactile Feedback**
```php
Haptics::vibrate();
```
Provide tactile feedback for user interactions, form validation, and important events.

### [PushNotifications](/docs/mobile/1/apis/push-notifications)
**Firebase Cloud Messaging**
```php
PushNotifications::enrollForPushNotifications();
PushNotifications::getPushNotificationsToken();
```
Register devices for push notifications and manage FCM tokens for server-side notification delivery.

### [SecureStorage](/docs/mobile/1/apis/secure-storage) ⭐ New in v1.1
**Keychain & Keystore Operations**
```php
SecureStorage::set('api_token', $token);
$token = SecureStorage::get('api_token');
SecureStorage::delete('api_token');
```
Store sensitive data securely using iOS Keychain and Android Keystore with automatic encryption.

### [System](/docs/mobile/1/apis/system)
**System Functions & Legacy API**
```php
System::flashlight(); // Toggle flashlight
```
Control system functions like the flashlight. Also provides deprecated methods that have moved to dedicated facades.

## API Patterns

### Synchronous APIs
Execute immediately and return results:
- `Haptics::vibrate()`
- `System::flashlight()`
- `Dialog::toast()`
- `SecureStorage::set()` / `get()`

### Asynchronous APIs
Trigger operations and fire events when complete:
- `Camera::getPhoto()` β†’ `PhotoTaken` event
- `Biometrics::promptForBiometricID()` β†’ `Completed` event
- `PushNotifications::enrollForPushNotifications()` β†’ `TokenGenerated` event
- `Geolocation::getCurrentPosition()` β†’ `LocationReceived` event

### Event Handling
All async APIs use Laravel events with Livewire integration:

```php
use Livewire\Attributes\On;
use Native\Mobile\Events\Camera\PhotoTaken;

#[On('native:' . PhotoTaken::class)]
public function handlePhotoTaken(string $path)
{
// Process the captured photo
}
```

## Migration from System Facade

Many methods have moved from the `System` facade to dedicated facades in v1.1:

| Old (Deprecated) | New (Recommended) |
|------------------|-------------------|
| `System::camera()` | `Camera::getPhoto()` |
| `System::vibrate()` | `Haptics::vibrate()` |
| `System::promptForBiometricID()` | `Biometrics::promptForBiometricID()` |
| `System::enrollForPushNotifications()` | `PushNotifications::enrollForPushNotifications()` |
| `System::secureSet()` / `secureGet()` | `SecureStorage::set()` / `get()` |

The old methods still work but are deprecated. See the [System API documentation](/docs/mobile/1/apis/system) for complete migration guidance.

## Platform Support

All APIs work on both iOS and Android with platform-appropriate implementations:
- **iOS**: Uses native iOS frameworks and APIs
- **Android**: Uses Android SDK and native libraries
- **Permissions**: Automatically handled with user prompts when required
- **Fallbacks**: Graceful degradation when features aren't available

## Error Handling

APIs provide both success and error events for proper error handling:

```php
#[On('native:' . PhotoTaken::class)]
public function handleSuccess($data) { /* ... */ }

#[On('native:' . PermissionDenied::class)]
public function handleError($error) { /* ... */ }
```

Each API documentation includes complete error handling examples and best practices.
93 changes: 93 additions & 0 deletions resources/views/docs/mobile/1/apis/biometrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: Biometrics
order: 100
---

## Overview

The Biometrics API allows you to authenticate users using their device's biometric sensors like Face ID, Touch ID, or fingerprint scanners.

```php
use Native\Mobile\Facades\Biometrics;
```

## Methods

### `promptForBiometricID()`

Prompts the user for biometric authentication.

## Events

### `Native\Mobile\Events\Biometric\Completed`

Fired when biometric authentication completes (success or failure).

```php
use Livewire\Attributes\On;
use Native\Mobile\Events\Biometric\Completed;

#[On('native:' . Completed::class)]
public function handleBiometricAuth(bool $success)
{
if ($success) {
// User authenticated successfully
$this->unlockSecureFeature();
} else {
// Authentication failed
$this->showErrorMessage();
}
}
```

## Example Usage

```php
use Livewire\Component;
use Livewire\Attributes\On;
use Native\Mobile\Facades\Biometrics;
use Native\Mobile\Events\Biometric\Completed;

class SecureArea extends Component
{
public bool $isUnlocked = false;
public bool $isAuthenticating = false;

public function authenticate()
{
$this->isAuthenticating = true;
Biometrics::promptForBiometricID();
}

#[On('native:' . Completed::class)]
public function handleBiometricAuth(bool $success)
{
$this->isAuthenticating = false;

if ($success) {
$this->isUnlocked = true;
session(['biometric_authenticated' => true]);
} else {
$this->addError('auth', 'Biometric authentication failed');
}
}

public function render()
{
return view('livewire.secure-area');
}
}
```

## Platform Support

- **iOS:** Face ID, Touch ID
- **Android:** Fingerprint, Face unlock, other biometric methods
- **Fallback:** System authentication (PIN, password, pattern)

## Security Notes

- Biometric authentication provides **convenience**, not absolute security
- Always combine with other authentication factors for sensitive operations
- Consider implementing session timeouts for unlocked states
- Users can potentially bypass biometrics if their device is compromised
Loading