Codelab: Compila un componente de historias

En este codelab, aprenderás a crear una experiencia similar a las historias de Instagram en la Web. Crearemos el componente a medida que avancemos, comenzando con HTML, luego CSS y, por último, JavaScript.

Consulta mi entrada de blog Cómo compilar un componente de Historias para obtener información sobre las mejoras progresivas que se realizaron durante la compilación de este componente.

Configuración

  1. Haz clic en Remix to Edit para que el proyecto se pueda editar.
  2. Abre app/index.html.

HTML

Siempre intento usar HTML semántico. Como cada amigo puede tener cualquier cantidad de historias, pensé que sería útil usar un elemento <section> para cada amigo y un elemento <article> para cada historia. Sin embargo, empecemos por el principio. Primero, necesitamos un contenedor para nuestro componente de historias.

Agrega un elemento <div> a tu <body>:

<div class="stories">

</div>

Agrega algunos elementos <section> para representar a los amigos:

<div class="stories">
  <section class="user"></section>
  <section class="user"></section>
  <section class="user"></section>
  <section class="user"></section>
</div>

Agrega algunos elementos <article> para representar historias:

<div class="stories">
  <section class="user">
    <article class="story" style="--bg: url(https://picsum.photos/480/840);"></article>
    <article class="story" style="--bg: url(https://picsum.photos/480/841);"></article>
  </section>
  <section class="user">
    <article class="story" style="--bg: url(https://picsum.photos/481/840);"></article>
  </section>
  <section class="user">
    <article class="story" style="--bg: url(https://picsum.photos/481/841);"></article>
  </section>
  <section class="user">
    <article class="story" style="--bg: url(https://picsum.photos/482/840);"></article>
    <article class="story" style="--bg: url(https://picsum.photos/482/843);"></article>
    <article class="story" style="--bg: url(https://picsum.photos/482/844);"></article>
  </section>
</div>
  • Usaremos un servicio de imágenes (picsum.com) para crear prototipos de historias.
  • El atributo style de cada <article> forma parte de una técnica de carga de marcadores de posición, sobre la que obtendrás más información en la siguiente sección.

CSS

Nuestro contenido está listo para que le apliquemos estilo. Convirtamos esos huesos en algo con lo que las personas quieran interactuar. Hoy trabajaremos con un enfoque centrado en dispositivos móviles.

.stories

Para nuestro contenedor <div class="stories">, queremos un contenedor de desplazamiento horizontal. Para lograrlo, podemos hacer lo siguiente:

  • Cómo convertir el contenedor en una cuadrícula
  • Configura cada elemento secundario para que complete la pista de la fila
  • Hacer que el ancho de cada elemento secundario sea el ancho de un viewport de dispositivo móvil

Grid seguirá colocando nuevas columnas de ancho 100vw a la derecha de la anterior, hasta que haya colocado todos los elementos HTML en tu lenguaje de marcado.

Chrome y las Herramientas para desarrolladores abiertas con un elemento visual de cuadrícula que muestra el diseño de ancho completo
Herramientas para desarrolladores de Chrome que muestran el desbordamiento de columnas de cuadrícula, lo que genera un desplazador horizontal.

Agrega el siguiente CSS al final de app/css/index.css:

.stories {
  display: grid;
  grid: 1fr / auto-flow 100%;
  gap: 1ch;
}

Ahora que tenemos contenido que se extiende más allá del viewport, es hora de indicarle a ese contenedor cómo manejarlo. Agrega las líneas de código destacadas a tu conjunto de reglas de .stories:

.stories {
  display: grid;
  grid: 1fr / auto-flow 100%;
  gap: 1ch;
  overflow-x: auto;
  scroll-snap-type: x mandatory;
  overscroll-behavior: contain;
  touch-action: pan-x;
}

Queremos un desplazamiento horizontal, por lo que estableceremos overflow-x en auto. Cuando el usuario se desplace, queremos que el componente se detenga suavemente en la siguiente historia, por lo que usaremos scroll-snap-type: x mandatory. Obtén más información sobre este CSS en las secciones Puntos de ajuste de desplazamiento de CSS y overscroll-behavior de mi entrada de blog.

Tanto el contenedor superior como los secundarios deben aceptar el ajuste de desplazamiento, así que veamos eso ahora. Agrega el siguiente código al final de app/css/index.css:

.user {
  scroll-snap-align: start;
  scroll-snap-stop: always;
}

Tu app aún no funciona, pero el siguiente video muestra lo que sucede cuando se habilita y se inhabilita scroll-snap-type. Cuando se habilita, cada desplazamiento horizontal se ajusta a la siguiente historia. Si la inhabilitas, el navegador usará su comportamiento de desplazamiento predeterminado.

Eso te permitirá desplazarte por tus amigos, pero aún tenemos un problema con las historias que debemos resolver.

.user

Creemos un diseño en la sección .user que organice esos elementos secundarios de la historia en su lugar. Usaremos un truco de apilamiento útil para resolver este problema. Básicamente, creamos una cuadrícula de 1 x 1 en la que la fila y la columna tienen el mismo alias de Grid de [story], y cada elemento de la cuadrícula de historias intentará reclamar ese espacio, lo que dará como resultado una pila.

Agrega el código destacado a tu conjunto de reglas de .user:

.user {
  scroll-snap-align: start;
  scroll-snap-stop: always;
  display: grid;
  grid: [story] 1fr / [story] 1fr;
}

Agrega el siguiente conjunto de reglas al final de app/css/index.css:

.story {
  grid-area: story;
}

Ahora, sin posicionamiento absoluto, elementos flotantes ni otras directivas de diseño que saquen un elemento del flujo, seguimos en el flujo. Además, casi no hay código, ¡mira eso! En el video y la entrada de blog, se desglosa esta información con más detalle.

.story

Ahora solo necesitamos aplicar diseño al elemento de la historia.

Anteriormente, mencionamos que el atributo style de cada elemento <article> forma parte de una técnica de carga de marcadores de posición:

<article class="story" style="--bg: url(https://picsum.photos/480/840);"></article>

Usaremos la propiedad background-image de CSS, que nos permite especificar más de una imagen de fondo. Podemos ordenarlas de modo que la imagen del usuario quede arriba y se muestre automáticamente cuando termine de cargarse. Para habilitar esto, colocaremos la URL de nuestra imagen en una propiedad personalizada (--bg) y la usaremos en nuestro CSS para crear capas con el marcador de posición de carga.

Primero, actualicemos el conjunto de reglas .story para reemplazar un gradiente por una imagen de fondo una vez que se haya cargado. Agrega el código destacado a tu conjunto de reglas de .story:

.story {
  grid-area: story;

  background-size: cover;
  background-image:
    var(--bg),
    linear-gradient(to top, lch(98 0 0), lch(90 0 0));
}

Establecer background-size en cover garantiza que no haya espacio vacío en el viewport, ya que nuestra imagen lo llenará. Definir 2 imágenes de fondo nos permite usar un truco web de CSS llamado loading tombstone:

  • La imagen de fondo 1 (var(--bg)) es la URL que pasamos intercalada en el código HTML.
  • Imagen de fondo 2 (linear-gradient(to top, lch(98 0 0), lch(90 0 0)) es un gradiente que se muestra mientras se carga la URL)

CSS reemplazará automáticamente el gradiente por la imagen una vez que se complete la descarga.

A continuación, agregaremos un poco de CSS para quitar algunos comportamientos y liberar el navegador para que se mueva más rápido. Agrega el código destacado a tu conjunto de reglas de .story:

.story {
  grid-area: story;

  background-size: cover;
  background-image:
    var(--bg),
    linear-gradient(to top, lch(98 0 0), lch(90 0 0));

  user-select: none;
  touch-action: manipulation;
}
  • user-select: none impide que los usuarios seleccionen texto por accidente.
  • touch-action: manipulation le indica al navegador que estas interacciones se deben tratar como eventos táctiles, lo que libera al navegador de intentar decidir si estás haciendo clic en una URL o no.

Por último, agreguemos un poco de CSS para animar la transición entre historias. Agrega el código destacado a tu conjunto de reglas .story:

.story {
  grid-area: story;

  background-size: cover;
  background-image:
    var(--bg),
    linear-gradient(to top, lch(98 0 0), lch(90 0 0));

  user-select: none;
  touch-action: manipulation;

  transition: opacity .3s cubic-bezier(0.4, 0.0, 1, 1);

  &.seen {
    opacity: 0;
    pointer-events: none;
  }
}

La clase .seen se agregará a una historia que necesita una salida. Obtuve la función de aceleración personalizada (cubic-bezier(0.4, 0.0, 1,1)) de la guía de aceleración de Material Design (desplázate hasta la sección Aceleración acelerada).

Si tienes un ojo agudo, probablemente hayas notado la declaración pointer-events: none y te estés rascando la cabeza en este momento. Diría que esta es la única desventaja de la solución hasta ahora. Necesitamos esto porque un elemento .seen.story estará en la parte superior y recibirá presiones, aunque sea invisible. Si establecemos el valor de pointer-events en none, convertimos la historia de vidrio en una ventana y no robamos más interacciones del usuario. No es un mal intercambio, no es muy difícil de administrar aquí en nuestro CSS en este momento. No estamos haciendo malabares con z-index. Sigo teniendo buenas sensaciones sobre esto.

JavaScript

Las interacciones de un componente de historias son bastante simples para el usuario: presionar a la derecha para avanzar y a la izquierda para retroceder. Las cosas simples para los usuarios suelen ser un trabajo difícil para los desarrolladores. Sin embargo, nosotros nos encargaremos de gran parte de eso.

Configuración

Para comenzar, calculemos y almacenemos la mayor cantidad de información posible. Agrega el siguiente código a app/js/index.js:

const stories = document.querySelector('.stories')
const median = stories.offsetLeft + (stories.clientWidth / 2)

Nuestra primera línea de JavaScript toma y almacena una referencia a nuestra raíz de elemento HTML principal. En la siguiente línea, se calcula dónde está el medio de nuestro elemento para que podamos decidir si una presión debe avanzar o retroceder.

Estado

A continuación, creamos un objeto pequeño con un estado relevante para nuestra lógica. En este caso, solo nos interesa la historia actual. En nuestro lenguaje de marcado HTML, podemos acceder a él tomando el primer amigo y su historia más reciente. Agrega el código destacado a tu app/js/index.js:

const stories = document.querySelector('.stories')
const median = stories.offsetLeft + (stories.clientWidth / 2)

const state = {
  current_story: stories.firstElementChild.lastElementChild
}

Objetos de escucha

Ahora tenemos suficiente lógica para comenzar a escuchar los eventos del usuario y dirigirlos.

Ratón

Comencemos por escuchar el evento 'click' en nuestro contenedor de historias. Agrega el código destacado a app/js/index.js:

const stories = document.querySelector('.stories')
const median = stories.offsetLeft + (stories.clientWidth / 2)

const state = {
  current_story: stories.firstElementChild.lastElementChild
}

stories.addEventListener('click', e => {
  if (e.target.nodeName !== 'ARTICLE')
    return

  navigateStories(
    e.clientX > median
      ? 'next'
      : 'prev')
})

Si se produce un clic y no es en un elemento <article>, salimos y no hacemos nada. Si es un artículo, tomamos la posición horizontal del mouse o el dedo con clientX. Aún no implementamos navigateStories, pero el argumento que toma especifica la dirección que debemos seguir. Si la posición del usuario es mayor que la mediana, sabemos que debemos navegar a next; de lo contrario, a prev (anterior).

Teclado

Ahora, escuchemos las pulsaciones del teclado. Si se presiona la flecha hacia abajo, navegamos a next. Si es la flecha hacia arriba, vamos a prev.

Agrega el código destacado a app/js/index.js:

const stories = document.querySelector('.stories')
const median = stories.offsetLeft + (stories.clientWidth / 2)

const state = {
  current_story: stories.firstElementChild.lastElementChild
}

stories.addEventListener('click', e => {
  if (e.target.nodeName !== 'ARTICLE')
    return

  navigateStories(
    e.clientX > median
      ? 'next'
      : 'prev')
})

document.addEventListener('keydown', ({key}) => {
  if (key !== 'ArrowDown' || key !== 'ArrowUp')
    navigateStories(
      key === 'ArrowDown'
        ? 'next'
        : 'prev')
})

Navegación por historias

Es hora de abordar la lógica empresarial única de las historias y la UX por la que se hicieron famosas. Esto parece complicado y difícil, pero creo que, si lo analizas línea por línea, verás que es bastante fácil de entender.

En primer lugar, guardamos algunos selectores que nos ayudan a decidir si desplazarnos hasta un amigo o mostrar/ocultar una historia. Como estamos trabajando en el HTML, lo consultaremos para ver si hay amigos (usuarios) o historias (historia).

Estas variables nos ayudarán a responder preguntas como, "dada la historia x, ¿"siguiente" significa pasar a otra historia de este mismo amigo o a un amigo diferente?" Lo hice con la estructura de árbol que creamos, accediendo a los elementos superiores y sus elementos secundarios.

Agrega el siguiente código al final de app/js/index.js:

const navigateStories = direction => {
  const story = state.current_story
  const lastItemInUserStory = story.parentNode.firstElementChild
  const firstItemInUserStory = story.parentNode.lastElementChild
  const hasNextUserStory = story.parentElement.nextElementSibling
  const hasPrevUserStory = story.parentElement.previousElementSibling
}

Este es nuestro objetivo de lógica empresarial, lo más cercano posible al lenguaje natural:

  • Decide cómo controlar la presión
    • Si hay una historia siguiente o anterior, se muestra esa historia.
    • Si es la última o la primera historia del amigo, muestra un amigo nuevo.
    • Si no hay ninguna historia en esa dirección, no hagas nada.
  • Guarda la nueva historia actual en state

Agrega el código destacado a tu función navigateStories:

const navigateStories = direction => {
  const story = state.current_story
  const lastItemInUserStory = story.parentNode.firstElementChild
  const firstItemInUserStory = story.parentNode.lastElementChild
  const hasNextUserStory = story.parentElement.nextElementSibling
  const hasPrevUserStory = story.parentElement.previousElementSibling

  if (direction === 'next') {
    if (lastItemInUserStory === story && !hasNextUserStory)
      return
    else if (lastItemInUserStory === story && hasNextUserStory) {
      state.current_story = story.parentElement.nextElementSibling.lastElementChild
      story.parentElement.nextElementSibling.scrollIntoView({
        behavior: 'smooth'
      })
    }
    else {
      story.classList.add('seen')
      state.current_story = story.previousElementSibling
    }
  }
  else if(direction === 'prev') {
    if (firstItemInUserStory === story && !hasPrevUserStory)
      return
    else if (firstItemInUserStory === story && hasPrevUserStory) {
      state.current_story = story.parentElement.previousElementSibling.firstElementChild
      story.parentElement.previousElementSibling.scrollIntoView({
        behavior: 'smooth'
      })
    }
    else {
      story.nextElementSibling.classList.remove('seen')
      state.current_story = story.nextElementSibling
    }
  }
}

Probar

  • Para obtener una vista previa del sitio, presiona View App y, luego, Fullscreen pantalla completa.

Conclusión

Eso es todo lo que necesitaba con el componente. No dudes en desarrollarlo, impulsarlo con datos y, en general, hacerlo tuyo.