Para mostrar a un usuario nuevo cómo aprovechar tu app, presenta información integrada cuando esta se inicie. A continuación, puedes ver algunos ejemplos:
- Presenta información detallada sobre qué canales están disponibles la primera vez que un usuario accede a una app de canales.
- Destaca las funciones notables de tu app.
- Explica los pasos obligatorios o recomendados que los usuarios deberían seguir cuando usen la app por primera vez.
La biblioteca de Leanback de AndroidX proporciona la clase OnboardingSupportFragment para presentar información al usuario que ingresa por primera vez. En esta lección, se describe cómo usar la clase OnboardingSupportFragment para presentar la información introductoria que se muestra cuando se inicia la app por primera vez. OnboardingSupportFragment usa las prácticas recomendadas de la IU de TV a fin de presentar la información de manera tal que coincida con los estilos de IU de TV y que sea fácil navegar en ella en dispositivos de TV.
Figura 1: Ejemplo de OnboardingSupportFragment
Tu OnboardingSupportFragment no debería contener elementos de IU que requieran entradas del usuario, como botones y campos.
Tampoco debería usarse como elemento de IU para una tarea que el usuario realizará con frecuencia. Si necesitas presentar una IU de varias páginas que requiera la entrada del usuario, considera usar un elemento GuidedStepSupportFragment.
Cómo agregar un elemento OnboardingSupportFragment
Para agregar un elemento OnboardingSupportFragment a tu app, implementa una clase que extienda la clase OnboardingSupportFragment. Agrega este fragmento a una actividad, ya sea mediante el XML de diseño de la actividad o de manera programática. Asegúrate de que la actividad o el fragmento use un tema derivado de Theme_Leanback_Onboarding, como se describe en Cómo personalizar temas.
En el método onCreate() de la actividad principal de tu app, llama a startActivity() con un elemento Intent que apunte a tu actividad principal OnboardingSupportFragment's. Esta acción garantiza que tu elemento OnboardingSupportFragment aparezca en cuanto se inicie la app.
A fin de asegurarte de que el elemento OnboardingSupportFragment aparezca solamente la primera vez que el usuario inicie tu app, usa un objeto SharedPreferences para registrar si el usuario ya vio el elemento OnboardingSupportFragment. Define un valor booleano que cambie a "verdadero" cuando el usuario termine de visualizar el elemento OnboardingSupportFragment. Comprueba este valor en el elemento onCreate() de tu actividad principal y solo inicia la actividad principal de OnboardingSupportFragment si el valor es "falso". En el siguiente ejemplo, se muestra una anulación del elemento onCreate() que comprueba la presencia de un valor SharedPreferences y, si no se establece como "verdadero", llama a startActivity() para mostrar el elemento OnboardingSupportFragment:
Kotlin
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
PreferenceManager.getDefaultSharedPreferences(this).apply {
// Check if we need to display our OnboardingSupportFragment
if (!getBoolean(MyOnboardingSupportFragment.COMPLETED_ONBOARDING_PREF_NAME, false)) {
// The user hasn't seen the OnboardingSupportFragment yet, so show it
startActivity(Intent(this@OnboardingActivity, OnboardingActivity::class.java))
}
}
}
Java
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
SharedPreferences sharedPreferences =
PreferenceManager.getDefaultSharedPreferences(this);
// Check if we need to display our OnboardingSupportFragment
if (!sharedPreferences.getBoolean(
MyOnboardingSupportFragment.COMPLETED_ONBOARDING_PREF_NAME, false)) {
// The user hasn't seen the OnboardingSupportFragment yet, so show it
startActivity(new Intent(this, OnboardingActivity.class));
}
}
Después de que el usuario vea el elemento OnboardingSupportFragment, márcalo como visto con el objeto SharedPreferences. Para ello, en tu OnboardingSupportFragment, anula onFinishFragment() y establece tu valor SharedPreferences en "verdadero", como se muestra en el siguiente ejemplo:
Kotlin
override fun onFinishFragment() {
super.onFinishFragment()
// User has seen OnboardingSupportFragment, so mark our SharedPreferences
// flag as completed so that we don't show our OnboardingSupportFragment
// the next time the user launches the app.
PreferenceManager.getDefaultSharedPreferences(context).edit().apply {
putBoolean(COMPLETED_ONBOARDING_PREF_NAME, true)
apply()
}
}
Java
@Override
protected void onFinishFragment() {
super.onFinishFragment();
// User has seen OnboardingSupportFragment, so mark our SharedPreferences
// flag as completed so that we don't show our OnboardingSupportFragment
// the next time the user launches the app.
SharedPreferences.Editor sharedPreferencesEditor =
PreferenceManager.getDefaultSharedPreferences(getContext()).edit();
sharedPreferencesEditor.putBoolean(
COMPLETED_ONBOARDING_PREF_NAME, true);
sharedPreferencesEditor.apply();
}
Cómo agregar páginas OnboardingSupportFragment
Después de agregar tu OnboardingSupportFragment, tendrás que definir páginas de integración. Un elemento OnboardingSupportFragment muestra contenido en una serie de páginas ordenadas. Cada página puede tener un título, una descripción y varias subvistas que pueden incluir imágenes y animaciones.
Figura 2: Elementos de la página OnboardingSupportFragment
En la figura 2, se muestra una página de ejemplo con texto destacado que marca elementos de página personalizables que tu OnboardingSupportFragment puede proporcionar. Los elementos de la página son los siguientes:
- El título de la página
- La descripción de la página
- La vista de contenido de la página, en este caso, una simple marca de verificación verde en un cuadro gris (esta vista es opcional y puedes usarla para mostrar detalles de la página, como una captura de pantalla que destaque la función de la app que se describe)
- La vista del segundo plano de la página, en este caso, un simple gradiente azul (esta vista siempre se procesa detrás de otras vistas de la página y es opcional)
- La vista de primer plano de la página, en este caso, un logotipo (esta vista siempre se procesa en primer plano, delante de las demás vistas de la página, y es opcional)
Inicializa la información de la página cuando OnboardingSupportFragment se cree por primera vez o esté adjuntado a una actividad principal, como la información de la página de solicitud del sistema cuando crea la vista del fragmento. Puedes inicializar la información de la página en tu constructor de clases o en una anulación de onAttach().
Anula cada uno de los siguientes métodos que proporcionen información de la página al sistema:
getPageCount()muestra la cantidad de páginas de tuOnboardingSupportFragment.getPageTitle()muestra el título del número de página solicitado.getPageDescription()muestra la descripción del número de página solicitado.
Anula cada uno de los siguientes métodos para proporcionar subvistas opcionales que se usan para mostrar imágenes o animaciones:
onCreateBackgroundView()muestra un objetoViewque puedes crear para que funcione como la vista en segundo plano, o bien un valor nulo si no se necesita una vista en segundo plano.onCreateContentView()muestra un objetoViewque puedes crear para que actúe como vista de contenido, o bien un valor nulo si no se necesita una vista de contenido.onCreateForegroundView()muestra un objetoViewque puedes crear para que actúe como vista en primer plano, o bien un valor nulo si no se necesita una vista en primer plano.
El sistema agrega el objeto View creado para el diseño de la página. En el siguiente ejemplo, se anula onCreateContentView() y se muestra un objeto ImageView:
Kotlin
private lateinit var contentView: ImageView
...
override fun onCreateContentView(inflater: LayoutInflater?, container: ViewGroup?): View? {
return ImageView(context).apply {
scaleType = ImageView.ScaleType.CENTER_INSIDE
setImageResource(R.drawable.onboarding_content_view)
setPadding(0, 32, 0, 32)
contentView = this
}
}
Java
private ImageView contentView;
...
@Override
protected View onCreateContentView(LayoutInflater inflater, ViewGroup container) {
contentView = new ImageView(getContext());
contentView.setScaleType(ImageView.ScaleType.CENTER_INSIDE);
contentView.setImageResource(R.drawable.onboarding_content_view);
contentView.setPadding(0, 32, 0, 32);
return contentView;
}
Cómo agregar una pantalla de logotipo inicial
Tu objeto OnboardingSupportFragment puede comenzar con una pantalla de logotipo opcional que presenta a tu app. Si deseas mostrar un objeto Drawable como pantalla de tu logotipo, en el método OnboardingSupportFragment's onCreate(), llama a setLogoResourceId() con el ID de tu Drawable. El sistema aplicará un fundido de entrada y mostrará el objeto Drawable brevemente. Luego, aplicará un fundido de salida para el objeto Drawable antes de mostrar la primera página de tu OnboardingSupportFragment.
Si quieres ofrecer una animación personalizada para tu pantalla de logotipo, en lugar de llamar a setLogoResourceId(), anula onCreateLogoAnimation() y muestra un objeto Animator que procese tu animación personalizada, como se muestra en el siguiente ejemplo:
Kotlin
public override fun onCreateLogoAnimation(): Animator =
AnimatorInflater.loadAnimator(context, R.animator.onboarding_logo_screen_animation)
Java
@Override
public Animator onCreateLogoAnimation() {
return AnimatorInflater.loadAnimator(getContext(),
R.animator.onboarding_logo_screen_animation);
}
Cómo personalizar animaciones de página
El sistema usa animaciones predeterminadas cuando muestra la primera página de tu OnboardingSupportFragment y cuando el usuario navega a una página diferente. Para anular los métodos en tu OnboardingSupportFragment, puedes personalizar estas animaciones.
Para personalizar la animación que aparece en tu primera página, anula onCreateEnterAnimation() y muestra un objeto Animator.
En el siguiente ejemplo, se crea un elemento Animator que escala la vista de contenido horizontalmente:
Kotlin
override fun onCreateEnterAnimation(): Animator =
ObjectAnimator.ofFloat(contentView, View.SCALE_X, 0.2f, 1.0f)
.setDuration(ANIMATION_DURATION)
Java
@Override
protected Animator onCreateEnterAnimation() {
Animator startAnimator = ObjectAnimator.ofFloat(contentView,
View.SCALE_X, 0.2f, 1.0f).setDuration(ANIMATION_DURATION);
return startAnimator;
}
Para personalizar la animación que se usa cuando el usuario navega a una página diferente, anula onPageChanged(). En tu método onPageChanged(), crea objetos Animators que quiten la página anterior y muestren la siguiente página, agrégalos a un AnimatorSet y reproduce el conjunto. En el siguiente ejemplo, se usa una animación con fundido de salida para quitar la página anterior, se actualiza la imagen de vista de contenido y se usa una animación con fundido de entrada para mostrar la página siguiente:
Kotlin
override fun onPageChanged(newPage: Int, previousPage: Int) {
// Create a fade-out animation used to fade out previousPage and, once
// done, swaps the contentView image with the next page's image.
val fadeOut = ObjectAnimator.ofFloat(mContentView, View.ALPHA, 1.0f, 0.0f)
.setDuration(ANIMATION_DURATION)
.apply {
addListener(object : AnimatorListenerAdapter() {
override fun onAnimationEnd(animation: Animator) {
mContentView.setImageResource(pageImages[newPage])
}
})
}
// Create a fade-in animation used to fade in nextPage
val fadeIn = ObjectAnimator.ofFloat(mContentView, View.ALPHA, 0.0f, 1.0f)
.setDuration(ANIMATION_DURATION)
// Create AnimatorSet with our fade-out and fade-in animators, and start it
AnimatorSet().apply {
playSequentially(fadeOut, fadeIn)
start()
}
}
Java
@Override
protected void onPageChanged(final int newPage, int previousPage) {
// Create a fade-out animation used to fade out previousPage and, once
// done, swaps the contentView image with the next page's image.
Animator fadeOut = ObjectAnimator.ofFloat(mContentView,
View.ALPHA, 1.0f, 0.0f).setDuration(ANIMATION_DURATION);
fadeOut.addListener(new AnimatorListenerAdapter() {
@Override
public void onAnimationEnd(Animator animation) {
mContentView.setImageResource(pageImages[newPage]);
}
});
// Create a fade-in animation used to fade in nextPage
Animator fadeIn = ObjectAnimator.ofFloat(mContentView,
View.ALPHA, 0.0f, 1.0f).setDuration(ANIMATION_DURATION);
// Create AnimatorSet with our fade-out and fade-in animators, and start it
AnimatorSet set = new AnimatorSet();
set.playSequentially(fadeOut, fadeIn);
set.start();
}
Para obtener más información sobre cómo crear Animators y AnimatorSets, consulta Animaciones de propiedades.
Cómo personalizar temas
Cualquier implementación de OnboardingSupportFragment debe usar el tema Theme_Leanback_Onboarding o un tema heredado de Theme_Leanback_Onboarding. Realiza una de las siguientes tareas para configurar el tema de tu OnboardingSupportFragment:
- Configura la actividad principal de
OnboardingSupportFragment'spara usar el tema deseado. En el siguiente ejemplo, se muestra cómo configurar una actividad para usarTheme_Leanback_Onboardingen el manifiesto de la app:<activity android:name=".OnboardingActivity" android:enabled="true" android:exported="true" android:theme="@style/Theme.Leanback.Onboarding"> </activity> -
Configura el tema de una actividad principal. Para ello, usa el atributo
LeanbackOnboardingTheme_onboardingThemeen un tema de actividad personalizado. Apunta este atributo a otro tema personalizado que solo usen los objetosOnboardingSupportFragmentde tu actividad. Usa este enfoque si tu actividad ya usa un tema personalizado y no quieres aplicar estilos deOnboardingSupportFragmenta otras vistas de la actividad. - Anula
onProvideTheme()y muestra el tema deseado. Usa este enfoque si varias actividades usan tuOnboardingSupportFragmento si la actividad principal no puede usar el tema deseado. En el siguiente ejemplo, se anulaonProvideTheme()y se muestra un objetoTheme_Leanback_Onboarding:Kotlin
override fun onProvideTheme(): Int = R.style.Theme_Leanback_OnboardingJava
@Override public int onProvideTheme() { return R.style.Theme_Leanback_Onboarding; }