SweetJuice Docs

Sweet Juice is an open-source Go framework for building native mobile apps with Material You design, deep system integrations, and a plugin-based architecture powered by gomobile.

Native UI — Declarative widgets in Go, rendered as native Android views via the mu3 plugin.
Material You — All built-in components use Material 3 dynamic color theming.
Plugin system — First-party plugins for permissions, notifications, biometrics, files, and more.
Cross-platform — Android and iOS from a single Go codebase.

WorkManager Plugin

The WorkManager plugin manages background tasks via the Android WorkManager API, supporting constraint-based one-time and periodic scheduling. Setup The WorkManager plugin is already registered in the default AppTemplate. Android Manifest <uses-permission android:name="android.permission.FOREGROUND_SERVICE" /> <uses-permission android:name="android.permission.FOREGROUND_SERVICE_SPECIAL_USE" /> API workmanager.NewPlugin() *WorkManagerPlugin Creates a new WorkManager plugin instance. (*WorkManagerPlugin).RegisterTask(name string, fn TaskFunc) Registers a task function that can be executed by WorkManager. type TaskFunc func() error (*WorkManagerPlugin).EnqueueOneTime(taskKey string, constraints *Constraints) (string, error) Schedules a one-time background task. (*WorkManagerPlugin).EnqueuePeriodic(taskKey string, intervalMinutes int, constraints *Constraints, replaceExisting bool, runImmediate bool) (string, error) Schedules a repeating background task using enqueueUniquePeriodicWork. ...

Special Permissions Plugin

The Special Permissions plugin handles Android permissions that cannot be requested through normal runtime dialogs. These require the user to manually enable them in system settings. Setup The special permissions plugin is already registered in the default AppTemplate. API special.Request(perm SpecialType) (string, error) Opens the system settings screen for the given permission type. special.Check(perm SpecialType) (bool, error) Checks whether the given special permission is currently granted. Special Permission Types Type Settings Screen Android Version Accessibility Settings.ACTION_ACCESSIBILITY_SETTINGS All AllFilesAccess Settings.ACTION_MANAGE_APP_ALL_FILES_ACCESS_PERMISSION 11+ BatteryExemption Settings.ACTION_REQUEST_IGNORE_BATTERY_OPTIMIZERS 6.0+ NotificationAccess Settings.ACTION_NOTIFICATION_LISTENER_SETTINGS All Convenience Helpers Function Description RequestAccessibility() (string, error) Opens Accessibility settings RequestAllFilesAccess() (string, error) Opens All Files Access settings (Android 11+) RequestBatteryExemption() (string, error) Opens battery optimization exemption dialog RequestNotificationAccess() (string, error) Opens notification access settings RequestAppSettings() (string, error) Opens app-specific system settings CheckAccessibility() (bool, error) Checks if Accessibility is granted CheckAllFilesAccess() (bool, error) Checks if All Files Access is granted CheckBatteryExemption() (bool, error) Checks if battery exemption is granted CheckNotificationAccess() (bool, error) Checks if notification access is granted Example import "github.com/sweet-juice/sweetjuice/plugins/special" // Request battery exemption special.RequestBatteryExemption() // Request notification access special.RequestNotificationAccess() // Check if notification access is granted granted, _ := special.CheckNotificationAccess() Android Notes These permissions cannot be requested via requestPermissions(). The user must manually enable them in the system settings screen. AllFilesAccess requires Android 11 (API 30) or higher. NotificationAccess requires a NotificationListenerService declared in the app manifest with the BIND_NOTIFICATION_LISTENER_SERVICE permission.

Notification Listener Plugin

The Notification Listener plugin receives callbacks when notifications are posted or removed on the device. It lets your Go code react to incoming notifications from any app. Setup The notification listener plugin is already registered in the default AppTemplate. Android Manifest The app must declare a NotificationListenerService and the user must grant notification access in system settings. <service android:name="com.sweetjuice.pkg.notifications.SweetJuiceNotificationListener" android:label="@string/app_name" android:permission="android.permission.BIND_NOTIFICATION_LISTENER_SERVICE" android:exported="false"> <intent-filter> <action android:name="android.service.notification.NotificationListenerService" /> </intent-filter> </service> Use the Special Permissions plugin to open the notification access settings screen: ...

DataDir Plugin

The DataDir plugin provides access to standard Android application directories and supports reading and writing files within internal storage. Setup The datadir plugin is already registered in the default AppTemplate. API datadir.NewPlugin() *DataDirPlugin Creates a new datadir plugin instance. (*DataDirPlugin).GetDirs() (AppDirs, error) Returns the application directory paths. type AppDirs struct { Files string // Internal files directory Cache string // Internal cache directory ExternalFiles string // External files directory (if available) ExternalCache string // External cache directory (if available) } (*DataDirPlugin).ReadFile(path string) (string, error) Reads the contents of a file from the internal files directory. ...

System Plugin

The System plugin provides comprehensive OS and device information. Setup The system plugin is already registered in the default AppTemplate. API system.NewPlugin() *SystemPlugin Creates a new System plugin instance. (*SystemPlugin).GetInfo() (SystemInfo, error) Returns OS and device information from the native layer. Returns: SystemInfo struct or error. Types SystemInfo type SystemInfo struct { SystemName string `json:"system_name"` SystemVersion string `json:"system_version"` Model string `json:"model"` SdkInt int `json:"sdk_int"` Release string `json:"release"` Codename string `json:"codename"` Manufacturer string `json:"manufacturer"` Brand string `json:"brand"` Board string `json:"board"` Device string `json:"device"` Product string `json:"product"` Hardware string `json:"hardware"` BaseOS string `json:"base_os"` SecurityPatch string `json:"security_patch"` Name string `json:"name"` LocalizedModel string `json:"localized_model"` IdentifierForVendor string `json:"identifier_for_vendor"` IsPhysicalDevice bool `json:"is_physical_device"` } Field Platform Description system_name All "Android" or "iOS" system_version All Human-readable OS version model All Device model name manufacturer Android Build.MANUFACTURER brand Android Build.BRAND release Android Build.VERSION.RELEASE sdk_int Android Build.VERSION.SDK_INT security_patch Android Security patch level is_physical_device All Whether the app is running on a real device Example import "github.com/sweet-juice/sweetjuice/plugins/system" plugin := system.NewPlugin() info, err := plugin.GetInfo() if err == nil { fmt.Printf("Device: %s %s\n", info.Manufacturer, info.Model) fmt.Printf("OS: %s %s\n", info.SystemName, info.SystemVersion) }

Broadcast Plugin

The Broadcast plugin provides a bridge to the Android system’s Intent-based broadcast infrastructure. Setup The broadcast plugin is already registered in the default AppTemplate. API broadcast.On(action string, callback func(interface{})) Registers a handler for a specific Android Intent action. When the OS fires a matching intent, the plugin captures it and forwards the extras as a Go map to your callback. broadcast.Post(action string, extras map[string]interface{}) Sends a system-wide broadcast (Intent) on the native side. ...