Los widgets de apps son vistas en miniatura de una app que puedes incorporar en otras apps, como la pantalla principal, y recibir actualizaciones periódicas. Estas vistas se denominan widgets en la interfaz de usuario, y puedes publicar una con un proveedor de widgets de la app (o un proveedor de widgets). Un componente de la app que contiene otros widgets se denomina host de widgets de la app (o host del widget). En la figura 1, se muestra un widget de música de ejemplo:
En este documento, se describe cómo publicar un widget usando un proveedor de widgets. Si quieres obtener información para crear tu propio AppWidgetHost
y alojar widgets de apps, consulta Cómo compilar un host de widgets.
Si deseas obtener información para diseñar tu widget, consulta Descripción general de los widgets de apps.
Componentes del widget
Para crear un widget, necesitas los siguientes componentes básicos:
- Objeto
AppWidgetProviderInfo
- Describe los metadatos de un widget, como su diseño, la frecuencia de actualización y la clase
AppWidgetProvider
.AppWidgetProviderInfo
se define en XML, como se describe en este documento. - Clase
AppWidgetProvider
- Define los métodos básicos que te permiten interactuar con el widget de manera programática. De esta manera, recibirás emisiones cuando el widget se actualice, se habilite, se inhabilite o se borre. Declara
AppWidgetProvider
en el manifiesto y, luego, lo implementas, como se describe en este documento. - Diseño de la vista
- Define el diseño inicial del widget. El diseño se define en XML, como se describe en este documento.
En la Figura 2, se muestra cómo estos componentes se ajustan al flujo de procesamiento general del widget de la app.
Si el widget necesita la configuración del usuario, implementa la actividad de configuración del widget de la app. Esta actividad permite a los usuarios modificar la configuración del widget, por ejemplo, la zona horaria de un widget de reloj.
- A partir de Android 12 (nivel de API 31), puedes proporcionar una configuración predeterminada y permitir que los usuarios vuelvan a configurar el widget más tarde. Consulta Cómo usar la configuración predeterminada del widget y Cómo permitir que los usuarios reconfiguren los widgets colocados para obtener más detalles.
- En Android 11 (nivel de API 30) o versiones anteriores, esta actividad se inicia cada vez que el usuario agrega el widget a su pantalla principal.
También recomendamos las siguientes mejoras: diseños de widgets flexibles, mejoras varias, widgets avanzados, widgets de colecciones y compilación de un host de widgets.
Cómo declarar el XML de AppWidgetProviderInfo
El objeto AppWidgetProviderInfo
define las cualidades esenciales de un widget.
Define el objeto AppWidgetProviderInfo
en un archivo de recursos XML usando un solo elemento <appwidget-provider>
y guárdalo en la carpeta res/xml/
del proyecto.
Esto se muestra en el siguiente ejemplo:
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:minWidth="40dp"
android:minHeight="40dp"
android:targetCellWidth="1"
android:targetCellHeight="1"
android:maxResizeWidth="250dp"
android:maxResizeHeight="120dp"
android:updatePeriodMillis="86400000"
android:description="@string/example_appwidget_description"
android:previewLayout="@layout/example_appwidget_preview"
android:initialLayout="@layout/example_loading_appwidget"
android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
android:resizeMode="horizontal|vertical"
android:widgetCategory="home_screen"
android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>
Atributos del tamaño de los widgets
La pantalla principal predeterminada coloca los widgets en su ventana en función de una cuadrícula de celdas que tienen una altura y un ancho definidos. La mayoría de las pantallas principales solo permiten que los widgets adquieran tamaños que sean múltiplos enteros de las celdas de cuadrícula, por ejemplo, dos celdas horizontalmente por tres celdas verticales.
Los atributos de tamaño del widget te permiten especificar un tamaño predeterminado y proporcionar límites inferiores y superiores para su tamaño. En este contexto, el tamaño predeterminado de un widget es el que adquiere cuando se lo agrega a la pantalla principal por primera vez.
En la siguiente tabla, se describen los atributos <appwidget-provider>
relacionados con el tamaño del widget:
Atributos y descripción | |
---|---|
targetCellWidth y targetCellHeight (Android 12), minWidth y minHeight |
targetCellWidth y targetCellHeight , y minWidth y minHeight ) para que tu app pueda volver a usar minWidth y minHeight si el dispositivo del usuario no es compatible con targetCellWidth y targetCellHeight . Si se admiten, los atributos targetCellWidth y targetCellHeight tienen prioridad sobre los atributos minWidth y minHeight .
|
minResizeWidth y minResizeHeight |
Especifica el tamaño mínimo absoluto del widget. Estos valores especifican el tamaño en el que el widget es ilegible o inutilizable. El uso de estos atributos permite al usuario cambiar el tamaño del widget a un tamaño menor que el predeterminado. Se ignora el atributo minResizeWidth si es mayor que minWidth o si no está habilitado el cambio de tamaño horizontal. Consulta resizeMode . Del mismo modo, se ignora el atributo minResizeHeight si es mayor que minHeight o si no está habilitado el cambio de tamaño vertical. |
maxResizeWidth y maxResizeHeight |
Especifica el tamaño máximo recomendado del widget. Si los valores no son múltiplos de las dimensiones de las celdas de la cuadrícula, se redondean al tamaño de celda más cercano. Se ignora el atributo maxResizeWidth si es más pequeño que minWidth o si no está habilitado el cambio de tamaño horizontal. Consulta resizeMode . Del mismo modo, se ignora el atributo maxResizeHeight si es mayor que minHeight o si no está habilitado el cambio de tamaño vertical.
Se introdujo en Android 12. |
resizeMode |
Especifica las reglas por las cuales se puede cambiar el tamaño de un widget. Puedes usar este atributo para hacer que los widgets de la pantalla principal puedan cambiar de tamaño horizontal, verticalmente o en ambos ejes. Los usuarios deben mantener presionado un widget para mostrar sus controladores de cambio de tamaño y, luego, arrastrar los controladores horizontales o verticales para cambiar su tamaño en la cuadrícula de diseño. Los valores para el atributo resizeMode incluyen horizontal , vertical y none . Para declarar que un widget se puede cambiar de tamaño horizontal y verticalmente, usa horizontal|vertical . |
Ejemplo
Para ilustrar cómo los atributos de la tabla anterior afectan el tamaño del widget, considera las siguientes especificaciones:
- Una celda de cuadrícula tiene 30 dp de ancho y 50 dp de alto.
- Se proporciona la siguiente especificación de atributo:
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:minWidth="80dp"
android:minHeight="80dp"
android:targetCellWidth="2"
android:targetCellHeight="2"
android:minResizeWidth="40dp"
android:minResizeHeight="40dp"
android:maxResizeWidth="120dp"
android:maxResizeHeight="120dp"
android:resizeMode="horizontal|vertical" />
A partir de Android 12:
Usa los atributos targetCellWidth
y targetCellHeight
como el tamaño predeterminado del widget.
El tamaño del widget es de 2 x 2 de forma predeterminada. Se puede cambiar el tamaño del widget a 2 × 1 o hasta 4 × 3.
Android 11 y versiones anteriores:
Usa los atributos minWidth
y minHeight
para calcular el tamaño predeterminado del widget.
El ancho predeterminado es Math.ceil(80 / 30)
= 3.
La altura predeterminada es Math.ceil(80 / 50)
= 2.
El tamaño del widget es 3x2 de forma predeterminada. Se puede cambiar el tamaño del widget a 2 × 1 o a pantalla completa.
Atributos adicionales del widget
En la siguiente tabla, se describen los atributos de <appwidget-provider>
relacionados con cualidades distintas del tamaño del widget.
Atributos y descripción | |
---|---|
updatePeriodMillis |
Define la frecuencia con la que el framework del widget solicita una actualización de AppWidgetProvider llamando al método de devolución de llamada onUpdate() . Con este valor, no se garantiza que la actualización real se realice exactamente a tiempo, y recomendamos realizarla con la menor frecuencia posible (no más de una vez por hora) para conservar la batería.
Si quieres obtener la lista completa de consideraciones para elegir un período de actualización apropiado, consulta Optimizaciones para actualizar el contenido del widget. |
initialLayout |
Apunta al recurso de diseño que define el diseño del widget. |
configure |
Define la actividad que se inicia cuando el usuario agrega el widget, y le permite configurar sus propiedades. Consulta Permite que los usuarios configuren widgets. A partir de Android 12, tu app puede omitir la configuración inicial. Para obtener más detalles, consulta Usa la configuración predeterminada del widget. |
description |
Especifica la descripción del selector del widget que se mostrará para tu widget. Se introdujo en Android 12. |
previewLayout (Android 12) y previewImage (Android 11 y versiones anteriores) |
previewImage y previewLayout para que tu app pueda volver a usar previewImage si el dispositivo del usuario no es compatible con previewLayout . Para obtener más detalles, consulta Retrocompatibilidad con vistas previas escalables de widgets.
|
autoAdvanceViewId |
Especifica el ID de vista de la subvista del widget que el host del widget avanza automáticamente. |
widgetCategory |
Declara si el widget se puede mostrar en la pantalla principal (home_screen ), en la pantalla de bloqueo (keyguard ) o en ambas. Para Android 5.0 y versiones posteriores, solo es válido home_screen .
|
widgetFeatures |
Declara funciones compatibles con el widget. Por ejemplo, si deseas que tu widget use su configuración predeterminada cuando un usuario lo agregue, especifica las marcas configuration_optional y reconfigurable . De esta manera, se evita iniciar la actividad de configuración después de que un usuario agrega el widget. El usuario aún podrá reconfigurar el widget más adelante. |
Usa la clase AppWidgetProvider para controlar las transmisiones de widgets
La clase AppWidgetProvider
controla las transmisiones y actualiza el widget en respuesta a los eventos de ciclo de vida del widget. En las siguientes secciones, se describe cómo declarar AppWidgetProvider
en el manifiesto y, luego, implementarlo.
Cómo declarar un widget en el manifiesto
Primero, declara la clase AppWidgetProvider
en el archivo AndroidManifest.xml
de la app, como se muestra en el siguiente ejemplo:
<receiver android:name="ExampleAppWidgetProvider"
android:exported="false">
<intent-filter>
<action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
</intent-filter>
<meta-data android:name="android.appwidget.provider"
android:resource="@xml/example_appwidget_info" />
</receiver>
El elemento <receiver>
requiere el atributo android:name
, que especifica el AppWidgetProvider
que usa el widget. El componente no debe exportarse, a menos que deba transmitirse un proceso separado a tu AppWidgetProvider
, lo que no suele suceder.
El elemento <intent-filter>
debe incluir un elemento <action>
con el atributo android:name
. Con este atributo, se especifica que AppWidgetProvider
acepta la transmisión de ACTION_APPWIDGET_UPDATE
. Esta es la única emisión que debes declarar de manera explícita. El AppWidgetManager
envía automáticamente todas las demás transmisiones de widgets a AppWidgetProvider
según sea necesario.
El elemento <meta-data>
especifica el recurso AppWidgetProviderInfo
y requiere los siguientes atributos:
android:name
: Especifica el nombre de los metadatos. Usaandroid.appwidget.provider
para identificar los datos como el descriptorAppWidgetProviderInfo
.android:resource
: Especifica la ubicación del recursoAppWidgetProviderInfo
.
Cómo implementar la clase AppWidgetProvider
La clase AppWidgetProvider
extiende BroadcastReceiver
como una clase de conveniencia para controlar las transmisiones de widgets. Solo recibe las transmisiones de eventos que son relevantes para el widget, como cuando se actualiza, se borra, se habilita o se inhabilita. Cuando se producen estos eventos de transmisión, se llama a los siguientes métodos AppWidgetProvider
:
onUpdate()
- Se llama a este método para actualizar el widget en intervalos definidos por el atributo
updatePeriodMillis
enAppWidgetProviderInfo
. Consulta la tabla en la que se describen los atributos adicionales de widgets de esta página para obtener más información. - También se llama a este método cuando el usuario agrega el widget, por lo que realiza la configuración esencial, como definir controladores de eventos para objetos
View
o iniciar trabajos para cargar datos que se mostrarán en el widget. Sin embargo, si declaras una actividad de configuración sin la marcaconfiguration_optional
, no se llama a este método cuando el usuario agrega el widget, pero se llama para las actualizaciones posteriores. Es responsabilidad de la actividad de configuración realizar la primera actualización cuando se completa la configuración. Para obtener más información, consulta Permite que los usuarios configuren widgets de apps. - La devolución de llamada más importante es
onUpdate()
. Consulta Controla eventos con la claseonUpdate()
en esta página para obtener más información. onAppWidgetOptionsChanged()
Se llama a este método cuando se coloca el widget por primera vez y cada vez que se cambia su tamaño. Usa esta devolución de llamada para ocultar o mostrar contenido según los rangos de tamaño del widget. Para obtener los rangos de tamaño y, a partir de Android 12, la lista de tamaños posibles que puede tomar una instancia de widget, llama a
getAppWidgetOptions()
, que muestra unBundle
que incluye lo siguiente:OPTION_APPWIDGET_MIN_WIDTH
: Contiene el límite inferior del ancho, en unidades dp, de una instancia de widget.OPTION_APPWIDGET_MIN_HEIGHT
: Contiene el límite inferior de la altura, en unidades dp, de una instancia de widget.OPTION_APPWIDGET_MAX_WIDTH
: Contiene el límite superior del ancho, en unidades dp, de una instancia de widget.OPTION_APPWIDGET_MAX_HEIGHT
: Contiene el límite superior de la altura, en unidades dp, de una instancia de widget.OPTION_APPWIDGET_SIZES
: Contiene la lista de tamaños posibles (List<SizeF>
), en unidades dp, que puede tomar una instancia de widget. Se introdujo en Android 12.
onDeleted(Context, int[])
Se llama a este método cada vez que se borra un widget del host del widget.
onEnabled(Context)
Se llama a este método cuando se crea una instancia del widget por primera vez. Por ejemplo, si el usuario agrega dos instancias de tu widget, solo se llama a este método la primera vez. Si necesitas abrir una base de datos nueva o realizar otra configuración que solo debe ocurrir una vez para todas las instancias de widgets, este es un buen lugar para hacerlo.
onDisabled(Context)
Se llama a este método cuando la última instancia del widget se borra del host del widget. Aquí limpias cualquier trabajo realizado en
onEnabled(Context)
, como borrar una base de datos temporal.onReceive(Context, Intent)
Se llama a este método para cada emisión y antes de cada uno de los métodos de devolución de llamada anteriores. Por lo general, no es necesario implementar este método, ya que la implementación predeterminada de
AppWidgetProvider
filtra todas las transmisiones del widget y llama a los métodos anteriores según corresponda.
Debes declarar la implementación de la clase AppWidgetProvider
como receptor de emisión mediante el elemento <receiver>
en AndroidManifest
. Para obtener más información, consulta Cómo declarar un widget en el manifiesto en esta página.
Controla eventos con la clase onUpdate()
La devolución de llamada AppWidgetProvider
más importante es onUpdate()
, ya que se llama cuando se agrega cada widget a un host, a menos que uses una actividad de configuración sin la marca configuration_optional
. Si el widget acepta algún
evento de interacción del usuario, registra los controladores de eventos en esta devolución de llamada. Si tu widget no crea archivos o bases de datos temporales, ni realiza otro trabajo que requiera limpieza, es posible que onUpdate()
sea el único método de devolución de llamada que debas definir.
Por ejemplo, si quieres un widget con un botón que inicie una actividad cuando se lo presione, puedes usar la siguiente implementación de AppWidgetProvider
:
Kotlin
class ExampleAppWidgetProvider : AppWidgetProvider() { override fun onUpdate( context: Context, appWidgetManager: AppWidgetManager, appWidgetIds: IntArray ) { // Perform this loop procedure for each widget that belongs to this // provider. appWidgetIds.forEach { appWidgetId -> // Create an Intent to launch ExampleActivity. val pendingIntent: PendingIntent = PendingIntent.getActivity( /* context = */ context, /* requestCode = */ 0, /* intent = */ Intent(context, ExampleActivity::class.java), /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE ) // Get the layout for the widget and attach an onClick listener to // the button. val views: RemoteViews = RemoteViews( context.packageName, R.layout.appwidget_provider_layout ).apply { setOnClickPendingIntent(R.id.button, pendingIntent) } // Tell the AppWidgetManager to perform an update on the current // widget. appWidgetManager.updateAppWidget(appWidgetId, views) } } }
Java
public class ExampleAppWidgetProvider extends AppWidgetProvider { public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { // Perform this loop procedure for each widget that belongs to this // provider. for (int i=0; i < appWidgetIds.length; i++) { int appWidgetId = appWidgetIds[i]; // Create an Intent to launch ExampleActivity Intent intent = new Intent(context, ExampleActivity.class); PendingIntent pendingIntent = PendingIntent.getActivity( /* context = */ context, /* requestCode = */ 0, /* intent = */ intent, /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE ); // Get the layout for the widget and attach an onClick listener to // the button. RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.example_appwidget_layout); views.setOnClickPendingIntent(R.id.button, pendingIntent); // Tell the AppWidgetManager to perform an update on the current app // widget. appWidgetManager.updateAppWidget(appWidgetId, views); } } }
Este AppWidgetProvider
solo define el método onUpdate()
, que lo usa para crear un PendingIntent
que inicia un Activity
y lo adjunta al botón del widget con setOnClickPendingIntent(int,
PendingIntent)
. Incluye un bucle que se itera a través de cada entrada en appWidgetIds
, que es un array de ID que identifican cada widget creado por este proveedor. Si el usuario crea más de una instancia del widget, todas se actualizan de forma simultánea. Sin embargo, solo se administra una programación updatePeriodMillis
para todas las instancias del widget. Por ejemplo, si el programa de actualización se define cada dos horas y se agrega una segunda instancia del widget una hora después de la primera, se actualizarán en el período definido por la primera y se ignorará el segundo período de actualización. Ambos se actualizan cada dos horas, no cada una hora.
Consulta la clase de muestra ExampleAppWidgetProvider.java
para obtener más detalles.
Cómo recibir intents de transmisión del widget
AppWidgetProvider
es una clase de conveniencia. Si quieres recibir las transmisiones del widget directamente, puedes implementar tu propio BroadcastReceiver
o anular la devolución de llamada onReceive(Context,Intent)
. Los intents a los que debes preocuparte son los siguientes:
ACTION_APPWIDGET_UPDATE
ACTION_APPWIDGET_DELETED
ACTION_APPWIDGET_ENABLED
ACTION_APPWIDGET_DISABLED
ACTION_APPWIDGET_OPTIONS_CHANGED
Cómo crear el diseño del widget
Debes definir un diseño inicial para tu widget en XML y guardarlo en el directorio res/layout/
del proyecto. Consulta los lineamientos de diseño para obtener más detalles.
Crear el diseño del widget es sencillo si estás familiarizado con los diseños. Sin embargo, ten en cuenta que los diseños de los widgets se basan en RemoteViews
, que no admite todos los tipos de widgets de diseño o vista. No puedes usar vistas personalizadas ni subclases de las vistas que sean compatibles con RemoteViews
.
RemoteViews
también admite ViewStub
, que es un View
invisible de tamaño cero que puedes usar para aumentar de forma diferida los recursos de diseño durante el tiempo de ejecución.
Compatibilidad con comportamiento con estado
En Android 12, se agrega compatibilidad para comportamiento con estado usando los siguientes componentes existentes:
El widget todavía no tiene un estado. La app debe almacenar el estado y registrarse para los eventos de cambio de estado.
En el siguiente ejemplo de código, se muestra cómo implementar estos componentes.
Kotlin
// Check the view. remoteView.setCompoundButtonChecked(R.id.my_checkbox, true) // Check a radio group. remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2) // Listen for check changes. The intent has an extra with the key // EXTRA_CHECKED that specifies the current checked state of the view. remoteView.setOnCheckedChangeResponse( R.id.my_checkbox, RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent) )
Java
// Check the view. remoteView.setCompoundButtonChecked(R.id.my_checkbox, true); // Check a radio group. remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2); // Listen for check changes. The intent has an extra with the key // EXTRA_CHECKED that specifies the current checked state of the view. remoteView.setOnCheckedChangeResponse( R.id.my_checkbox, RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent));
Proporciona dos diseños: uno que se oriente a dispositivos que ejecutan Android 12 o versiones posteriores en res/layout-v31
, y otro que se oriente a Android 11 anterior o versiones anteriores en la carpeta res/layout
predeterminada.
Cómo implementar esquinas redondeadas
En Android 12, se introducen los siguientes parámetros del sistema para establecer los radios de las esquinas redondeadas del widget:
system_app_widget_background_radius
: El radio de la esquina del fondo del widget, que nunca es superior a 28 dp.system_app_widget_inner_radius
: El radio de la esquina de cualquier vista dentro del widget. Es exactamente 8 dp menos que el radio de fondo, para alinearse bien cuando se usa un padding de 8 dp.
En el siguiente ejemplo, se muestra un widget que usa system_app_widget_background_radius
para su esquina y system_app_widget_inner_radius
para las vistas dentro de este.
1 Esquina del widget.
2 Esquina de una vista dentro del widget.
Consideraciones importantes sobre las esquinas redondeadas
- Los selectores de terceros y los fabricantes de dispositivos pueden anular el parámetro
system_app_widget_background_radius
para que sea inferior a 28 dp. El parámetrosystem_app_widget_inner_radius
siempre es 8 dp menos que el valor desystem_app_widget_background_radius
. - Si tu widget no usa
@android:id/background
o define un fondo que recorta su contenido según el contorno (conandroid:clipToOutline
configurado entrue
), el selector identifica automáticamente el fondo y recorta el widget usando un rectángulo con esquinas redondeadas de hasta 16 dp. Consulta Asegúrate de que el widget sea compatible con Android 12.
Para lograr la compatibilidad del widget con versiones anteriores de Android, te recomendamos que definas los atributos personalizados y uses un tema personalizado para anularlos en Android 12, como se muestra en los siguientes archivos en formato XML de ejemplo:
/values/attrs.xml
<resources>
<attr name="backgroundRadius" format="dimension" />
</resources>
/values/styles.xml
<resources>
<style name="MyWidgetTheme">
<item name="backgroundRadius">@dimen/my_background_radius_dimen</item>
</style>
</resources>
/values-31/styles.xml
<resources>
<style name="MyWidgetTheme" parent="@android:style/Theme.DeviceDefault.DayNight">
<item name="backgroundRadius">@android:dimen/system_app_widget_background_radius</item>
</style>
</resources>
/drawable/my_widget_background.xml
<shape xmlns:android="http://schemas.android.com/apk/res/android"
android:shape="rectangle">
<corners android:radius="?attr/backgroundRadius" />
...
</shape>
/layout/my_widget_layout.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
...
android:background="@drawable/my_widget_background" />