#Querying Active Widgets

On Android, you can detect every active instance of your widgets currently placed on the Home Screen. This is particularly useful for Android since each widget instance can have different dimensions and a unique widgetId.

#getActiveWidgets API

The getActiveWidgets function returns a promise that resolves to an array of all active widget instances for your app.

import { getActiveWidgets } from 'voltra/android'

async function checkAndroidWidgets() {
  const activeWidgets = await getActiveWidgets()

  console.log(`Found ${activeWidgets.length} active widget instances`)

  activeWidgets.forEach(widget => {
    console.log(`- Widget Name: ${widget.name}`)
    console.log(`  ID: ${widget.widgetId}`)
    console.log(`  Size: ${widget.width}x${widget.height}dp`)
  })
}

#WidgetInfo Object

Each object in the returned array contains: