Alpha documentation — APIs may change between 0.x releases.
MAUI Essentials
These generated modules wrap
.NET MAUI Essentials
for the web layer. Call essentials.getSupport() before using a feature that
may not be available on the current platform.
secureStorage
Encrypted key/value storage backed by the platform credential store.
| Method | Payload | Returns |
|---|
get | { key } | { value? } |
set | { key, value } | { success } |
remove | { key } | { removed } |
removeAll | none | { success } |
get returns null when the key does not exist.
preferences
Lightweight, unencrypted app settings. Use secureStorage for secrets.
| Method | Payload | Returns |
|---|
get | { key } | { value? } |
set | { key, value } | { success } |
remove | { key } | { success } |
containsKey | { key } | { exists } |
clear | none | { success } |
device
| Method | Payload | Returns |
|---|
getInfo | none | { model, manufacturer, name, version, platform, idiom, deviceType } |
getDisplay | none | { width, height, density, orientation, rotation } |
share
| Method | Payload | Returns |
|---|
shareText | { text, title?, subject?, uri? } | { success } |
browser
| Method | Payload | Returns |
|---|
open | { url, mode?: "systemPreferred" | "external" } | { success } |
launcher
Open an HTTP URL, mailto:, tel:, custom scheme, or file in its registered
system handler.
| Method | Payload | Returns |
|---|
open | { uri } | { success } |
canOpen | { uri } | { canOpen } |
email
| Method | Payload | Returns |
|---|
compose | { subject?, body?, to?, cc?, bcc? } | { success } |
filePicker
The picker returns metadata. Read file contents with filesystem and the
returned fullPath.
| Method | Payload | Returns |
|---|
pickOne | { title? } | { file?: { fileName, fullPath, contentType? } } |
pickMultiple | { title? } | { files: [{ fileName, fullPath, contentType? }] } |
pickOne returns null when the user cancels.
textToSpeech
| Method | Payload | Returns |
|---|
speak | { text, pitch?, volume? } | { success } |
connectivity
| Method | Payload | Returns |
|---|
getStatus | none | { access, profiles } |
access: "unknown" | "none" | "local" | "constrainedInternet" | "internet"
profiles: ("unknown" | "bluetooth" | "cellular" | "ethernet" | "wifi")[]
- Event:
connectivity.onChanged(handler)
battery
| Method | Payload | Returns |
|---|
getStatus | none | { chargeLevel, state, powerSource, energySaver } |
state: "unknown" | "charging" | "discharging" | "full" | "notCharging" | "notPresent"
powerSource: "unknown" | "battery" | "ac" | "wireless"
energySaver: "unknown" | "on" | "off"
- Event:
battery.onChanged(handler)
essentials
| Method | Payload | Returns |
|---|
getSupport | none | Per-platform support for every Essentials module |
import { essentials, filePicker } from "@vidra-dev/sdk";
const support = await essentials.getSupport();
if (support.filePicker) {
const { file } = await filePicker.pickOne({ title: "Choose a document" });
}