Docs Reference
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.

MethodPayloadReturns
get{ key }{ value? }
set{ key, value }{ success }
remove{ key }{ removed }
removeAllnone{ success }

get returns null when the key does not exist.

preferences

Lightweight, unencrypted app settings. Use secureStorage for secrets.

MethodPayloadReturns
get{ key }{ value? }
set{ key, value }{ success }
remove{ key }{ success }
containsKey{ key }{ exists }
clearnone{ success }

device

MethodPayloadReturns
getInfonone{ model, manufacturer, name, version, platform, idiom, deviceType }
getDisplaynone{ width, height, density, orientation, rotation }

share

MethodPayloadReturns
shareText{ text, title?, subject?, uri? }{ success }

browser

MethodPayloadReturns
open{ url, mode?: "systemPreferred" | "external" }{ success }

launcher

Open an HTTP URL, mailto:, tel:, custom scheme, or file in its registered system handler.

MethodPayloadReturns
open{ uri }{ success }
canOpen{ uri }{ canOpen }

email

MethodPayloadReturns
compose{ subject?, body?, to?, cc?, bcc? }{ success }

filePicker

The picker returns metadata. Read file contents with filesystem and the returned fullPath.

MethodPayloadReturns
pickOne{ title? }{ file?: { fileName, fullPath, contentType? } }
pickMultiple{ title? }{ files: [{ fileName, fullPath, contentType? }] }

pickOne returns null when the user cancels.

textToSpeech

MethodPayloadReturns
speak{ text, pitch?, volume? }{ success }

connectivity

MethodPayloadReturns
getStatusnone{ access, profiles }
  • access: "unknown" | "none" | "local" | "constrainedInternet" | "internet"
  • profiles: ("unknown" | "bluetooth" | "cellular" | "ethernet" | "wifi")[]
  • Event: connectivity.onChanged(handler)

battery

MethodPayloadReturns
getStatusnone{ 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

MethodPayloadReturns
getSupportnonePer-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" });
}