API Reference mob v#0.5.1

Copy Markdown View Source

Modules

Mob

Mob — BEAM-on-device mobile framework for Elixir.

Native alert dialogs, action sheets, and toast messages.

Behaviour for Mob application entry point.

Microphone recording and audio playback.

Biometric authentication (Face ID / Touch ID / fingerprint).

Native camera capture for photos and videos.

System clipboard access. No permission required.

Behaviour for native view components.

Platform-aware Erlang distribution startup.

System file picker. Opens the OS document picker (Files app on iOS, SAF on Android).

Haptic feedback. No permission required on either platform.

Data-driven list component.

Bridge between Phoenix LiveView and the Mob native WebView.

Device location (GPS / network).

Accelerometer and gyroscope sensor data.

OTP logger handler that routes Elixir Logger output to the platform's native system log.

ETS-backed registry mapping screen name atoms to their modules.

Local and push notifications.

Request OS-level permissions from the user.

Photo / video library picker.

Maps component names (atoms) to their platform-specific NIF constructors.

Serializes a component tree to JSON and passes it to the platform NIF in a single call. Compose (Android) and SwiftUI (iOS) handle diffing and rendering internally.

QR code and barcode scanner.

The behaviour and process wrapper for a Mob screen.

System share sheet. Opens the OS share dialog with a piece of content. Fire-and-forget — no response arrives in the BEAM.

The ~MOB sigil for declarative native UI.

The socket struct passed through all Mob.Screen and Mob.Component callbacks.

Persistent key-value store for app state.

App-local file storage.

Android-specific storage locations and MediaStore integration.

iOS-specific storage locations and media library integration.

Thin wrapper around a props map for named, reusable styles.

Remote inspection and interaction helpers for connected Mob apps.

Design token system for Mob apps.

Birch theme for Mob — warm parchment surfaces with a chestnut-brown accent.

Citrus theme for Mob — warm charcoal with a lime-green accent.

Obsidian theme for Mob — deep blacks with a violet accent.

UI component constructors for the Mob framework.

Bidirectional JS bridge for the native WebView component.

Mix Tasks

Runs the Mob onboarding integration tests, which verify that a new user can go from zero to a running app without hitting any friction that should have been caught automatically.