Cómo presentar tu app a los usuarios que acceden por primera vez

Compila mejor con Compose

Crea IUs atractivas con un código mínimo usando Jetpack Compose para Android TV OS.

Compose para TV →

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 androidx.leanback proporciona la OnboardingSupportFragment clase para presentar información al usuario que ingresa por primera vez. En esta guía, 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 para 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: Un ejemplo de OnboardingSupportFragment.

OnboardingSupportFragment no es adecuado para todos los casos de uso. No uses OnboardingSupportFragment cuando necesites incluir elementos de IU que requieran entradas del usuario, como botones y campos. Además, no uses OnboardingSupportFragment para las tareas que el usuario realizará con regularidad. Por último, 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 OnboardingSupportFragment a tu app, implementa una clase que extienda la OnboardingSupportFragment clase. 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 la sección Personalizar temas.

En el método onCreate() de la actividad principal de tu app, llama a startActivity() con un elemento Intent que apunte a la actividad principal de tu OnboardingSupportFragment. Esto garantiza que tu elemento OnboardingSupportFragment aparezca en cuanto se inicie la app.

Para 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 método 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 de onCreate() que verifica un valor SharedPreferences y, si no está configurado como verdadero, llama a startActivity() para mostrar el elemento OnboardingSupportFragment:

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))
        }
    }
}

@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, anula onFinishFragment() en tu OnboardingSupportFragment y configura tu valor SharedPreferences como verdadero, como se muestra en el siguiente ejemplo:

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()
    }
}

@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

Un elemento OnboardingSupportFragment muestra contenido en una serie de páginas ordenadas. Después de agregar tu OnboardingSupportFragment, debes definir las páginas de incorporación. 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 leyendas que marcan elementos de página personalizables que tu OnboardingSupportFragment puede proporcionar. Los elementos de la página son los siguientes:

1. El título de la página
2. La descripción de la página
3. La vista de contenido de la página, en este caso, una simple marca de verificación verde en un cuadro gris y 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)
4. 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)
5. 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 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.OnboardingSupportFragment 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 proporcionan información de la página al sistema:

• getPageCount() muestra la cantidad de páginas en tu OnboardingSupportFragment.
• 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 objeto View que 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 objeto View que puedes crear para que funcione como la vista de contenido, o bien un valor nulo si no se necesita una vista de contenido.
• onCreateForegroundView() muestra un View que puedes crear para que funcione como la vista en primer plano, o bien un valor nulo si no se necesita una vista en primer plano.

El sistema agrega el objeto View que creas al diseño de la página. En el siguiente ejemplo, se anula onCreateContentView() y se muestra un objeto ImageView:

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
    }
}

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 OnboardingSupportFragment puede comenzar con una pantalla de logotipo opcional que presenta a tu app. Si deseas mostrar un Drawable como pantalla de tu logotipo, llama a setLogoResourceId() con el ID de tu Drawable en el métodoonCreate() de tu OnboardingSupportFragment. 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:

public override fun onCreateLogoAnimation(): Animator =
        AnimatorInflater.loadAnimator(context, R.animator.onboarding_logo_screen_animation)

@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 personalizar estas animaciones, puedes anular métodos de tu OnboardingSupportFragment.

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:

override fun onCreateEnterAnimation(): Animator =
    ObjectAnimator.ofFloat(contentView, View.SCALE_X, 0.2f, 1.0f)
            .setDuration(ANIMATION_DURATION)

@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 Animator 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:

override fun onPageChanged(newPage: Int, previousPage: Int) {
    // Create a fade-out animation for previousPage and, once
    // done, swap 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 for nextPage
    val fadeIn = ObjectAnimator.ofFloat(mContentView, View.ALPHA, 0.0f, 1.0f)
            .setDuration(ANIMATION_DURATION)
    // Create AnimatorSet with fade-out and fade-in animators and start it
    AnimatorSet().apply {
        playSequentially(fadeOut, fadeIn)
        start()
    }
}

@Override
protected void onPageChanged(final int newPage, int previousPage) {
    // Create a fade-out animation for previousPage and, once
    // done, swap 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 for nextPage
    Animator fadeIn = ObjectAnimator.ofFloat(mContentView,
            View.ALPHA, 0.0f, 1.0f).setDuration(ANIMATION_DURATION);
    // Create AnimatorSet with 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 Animator objetos y AnimatorSet objetos, consulta Descripción general de la animación de propiedades.

Personalizar temas

Cualquier OnboardingSupportFragment implementación debe usar el tema o un tema heredado de Theme_Leanback_Onboarding.Theme_Leanback_Onboarding Para configurar el tema de tu OnboardingSupportFragment, haz una de las siguientes acciones:

• Configura la actividad principal de OnboardingSupportFragment para usar el tema deseado. En el siguiente ejemplo, se muestra cómo configurar una actividad para usar Theme_Leanback_Onboarding en 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_onboardingTheme en un tema de actividad personalizado. Dirige este atributo a otro tema personalizado que solo usen los objetos OnboardingSupportFragment de tu actividad. Usa este enfoque si tu actividad ya usa un tema personalizado y no quieres aplicar estilos de OnboardingSupportFragment a otras vistas de la actividad.
• Anula onProvideTheme() y muestra el tema deseado. Usa este enfoque si varias actividades usan tu OnboardingSupportFragment o si la actividad principal no puede usar el tema deseado. En el siguiente ejemplo, se anula onProvideTheme() y se muestra Theme_Leanback_Onboarding:

  Kotlin

  override fun onProvideTheme(): Int = R.style.Theme_Leanback_Onboarding

  Java

  @Override
  public int onProvideTheme() {
     return R.style.Theme_Leanback_Onboarding;
  }