Introducción
La StatusBar es un área importante de cara al usuario final. Disponible para mostrar información importante relacionada con el estado del sistema (hora, batería, red, etc.) además de notificaciones de otras aplicaciones.
Al desarrollar aplicaciones móviles, entre los objetivos, debemos conseguir un estilo único y uniforme. Para conseguirlo, en ocasiones será necesario modificar el aspecto de la StatusBar o incluso cambiarlo de forma uniforme para adaptarla a diferentes páginas de nuestra aplicación.
¿Cómo personalizamos la StatusBar?. En este artículo vamos a crear un efecto de Xamarin.Forms para personalizar la StatusBar en Android, iOS y en UWP.
Efectos
Un efecto permite el acceso al control nativo de cada plataforma con el objetivo de personalizarlo, principalmente aplicando pequeños cambios estéticos o de comportamiento. Permiten simplificar la personalización del control y sobretodo se convierten en “piezas” reutilizables de código incluso aceptando parametrización.
Crear un efecto
El proceso de creación de un efecto, se puede resumir en una serie de sencillos pasos:
- Crear en la libería .NET Standard una clase que herede de RoutingEffect. Código independiente de la plataforma encargado de hacer el wrapping del efecto. Podemos definir distintas propiedades que permitan modificar la acción realizada por el efecto. Por ejemplo, en un efecto encargado de aplicar Blur a una imagen, se puede definir una propiedad encarga de aplicar mayor o menor distorsión.
- Crear clases en cada plataforma soportada que hereden de PlatformEffect.
- Sobrecargar el método OnAttached y añadir la lógica de personalización del control.
- Sobrecargar el método OnDetached y añadir lógica de liberación de recursos.
- Añadir el atributo ResolutionGroupName. Este atributo permite establecer el nombre del creador o compañia tras el efecto. Recuerda que uno de los objetivos fundamentales de los efectos es lograr permitir compartir y reutilizar con suma facilidad. Con este atributo se previenen colisiones con otros efectos que compartan nombre.
- Añadir el atributo ExportEffect. Este atributo registra el efecto con un identificador único usado por Xamarin.Forms, junto al nombre del grupo, permite localizar y aplicar el efecto.
Definición del efecto
Comenzamos con la definición del efecto. Creamos una clase que hereda de RoutingEffect:
public class StatusBarEffect : RoutingEffect
{
public Color BackgroundColor { get; set; }
public StatusBarEffect() : base("Xamarin.StatusBarEffect")
{
}
}
Fíjate que definimos una propiedad de tipo Color llamada BackgroundColor que nos permitirá establecer el color de la StatusBar.
Android
En Android, accedemos a la Window de la actividad, para modificar el color de la StatusBar utilizando el método SetStatusBarColor:
var statusBarEffect = (StatusBarXamarinForms.Effects.StatusBarEffect)Element.Effects.FirstOrDefault(e => e is StatusBarXamarinForms.Effects.StatusBarEffect);
if (statusBarEffect != null)
{
var backgroundColor = statusBarEffect.BackgroundColor.ToAndroid();
Window currentWindow = GetCurrentWindow();
currentWindow.SetStatusBarColor(backgroundColor);
}
Convertimos el color de Xamarin.Forms a Android utilizando la extensión ToAndroid. Mientras que, para tener acceso de forma sencilla a la actividad actual, usamos el plugin CurrentActivityPlugin:
var window = CrossCurrentActivity.Current.Activity.Window;
iOS
En iOS, accedemos a la StatusBar, y le establecemos el color de fondo utilizando la propiedad BackgroundColor:
if (statusBarEffect != null)
{
UIView statusBar = UIApplication.SharedApplication.ValueForKey(new NSString("statusBar")) as UIView;
if (statusBar.RespondsToSelector(new ObjCRuntime.Selector("setBackgroundColor:")))
{
statusBar.BackgroundColor = statusBarEffect.BackgroundColor.ToUIColor();
}
}
En este caso, el color lo convertimos a un UIColor con la extensión ToUIColor.
UWP
En el caso de UWP, contemplamos dos posibilidades:
NOTA: Para tener acceso a estas APIs es necesario añadir como referencia a las extensiones UWP correspondientes.
Comenzamos por el uso de la TitleBar:
// Desktop Customization
if (ApiInformation.IsTypePresent("Windows.UI.ViewManagement.ApplicationView"))
{
var titleBar = ApplicationView.GetForCurrentView().TitleBar;
if (titleBar != null)
{
titleBar.BackgroundColor = statusBackgroundColor;
titleBar.ButtonBackgroundColor = statusBackgroundColor;
}
}
Accedemos a la misma y establecemos el color de fondo.
En el caso de StatusBar es bastante similar:
// Mobile Customization
if (ApiInformation.IsTypePresent("Windows.UI.ViewManagement.StatusBar"))
{
var statusBar = StatusBar.GetForCurrentView();
if (statusBar != null)
{
statusBar.BackgroundOpacity = 1;
statusBar.BackgroundColor = statusBackgroundColor;
}
}
Sencillo, ¿verdad?.
Utilizando el efecto
Llega el momento de utilizar nuestro efecto!. Comenzamos añadiendo el namespace correspondiente en XAML:
xmlns:local="clr-namespace:StatusBarXamarinForms.Effects"
Y utilizamos el efecto:
<ContentPage.Effects>
<local:StatusBarEffect
BackgroundColor="Red"/>
</ContentPage.Effects>
El resultado:
Podemos añadir el efecto desde código C# y nos da la posibilidad de moficar la StatusBar programáticamente de forma sencilla.
Puedes encontrar el ejemplo en GitHub:
Más información
- Apple Developer: Status Bars