Designing for Different Devices (Viewport Size, Touch/Hover, etc.)

Documentation Guides pour les développeurs
1

This document outlines the APIs used to adapt Discourse’s user interface for different devices.

Viewport Size

The most important characteristic to consider is the viewport size. We design “mobile first” and then add customizations for larger devices as needed. The breakpoints we use are:

Breakpoint Size Pixels (at 16px body font size)
sm 40rem 640px
md 48rem 768px
lg 64rem 1024px
xl 80rem 1280px
2xl 96rem 1536px

To use these in an SCSS file, add @use "lib/viewport"; at the top of the file, then use one of the available mixins:

@use "lib/viewport";

@include viewport.from(lg) {
  // SCSS rules here will be applied to
  // devices larger than the lg breakpoint
}

@include viewport.until(sm) {
  // SCSS rules here will be applied to
  // devices smaller than the sm breakpoint
}

@include viewport.between(sm, md) {
  // SCSS rules here will be applied to
  // devices with a size between the sm
  // and md breakpoints
}

In general, SCSS is the recommended way to handle layout differences based on viewport size. For advanced cases, the same breakpoints can be accessed in Ember components via the capabilities service. For example:

import Component from "@glimmer/component";
import { service } from "@ember/service";

class MyComponent extends Component {
  @service capabilities;

  <template>
    {{#if this.capabilities.viewport.lg}}
      This text will be displayed for devices larger than the lg breakpoint
    {{/if}}

    {{#unless this.capabilities.viewport.sm}}
      This text will be displayed for devices smaller than the sm breakpoint
    {{/unless}}
  </template>
}

These properties are reactive, and Ember will automatically re-render the relevant parts of the template as the browser is resized.

Touch & Hover

Some devices only have touchscreens, some only have a traditional mouse pointer, and some have both. Importantly, touchscreen users cannot “hover” over elements. Therefore, interfaces should be designed to work entirely without hover states, with hover-specific enhancements added for devices that support them.

There are several ways to detect touch/hover capability via CSS and JavaScript. For consistency, we recommend using Discourse’s helpers instead of those CSS/JS APIs directly.

For CSS, you can target the .discourse-touch and .discourse-no-touch classes, which are added to the <html> element. These are determined based on the (any-pointer: coarse) media query.

For example:

html.discourse-touch {
  // SCSS rules here will apply to devices with a touch screen,
  // including mobiles/tablets and laptops/desktops with touch screens.
}

html.discourse-no-touch {
  // SCSS rules here will apply to devices with no touch screen.
}

This information is also available in Ember components via the capabilities service:

import Component from "@glimmer/component";
import { service } from "@ember/service";

class MyComponent extends Component {
  @service capabilities;

  <template>
    {{#if this.capabilities.touch}}
      This text will be displayed for devices with a touch screen
    {{/if}}

    {{#unless this.capabilities.touch}}
      This text will be displayed for devices with no touch screen
    {{/unless}}
  </template>
}

Legacy Mobile / Desktop Modes

Historically, Discourse shipped two completely different layouts and stylesheets for “mobile” and “desktop” views, based on the browser’s user-agent. Developers would target these modes by putting CSS in specific mobile/desktop directories, by using the .mobile-view/.desktop-view HTML classes, and the site.mobileView boolean in JavaScript.

These techniques are now considered deprecated and should be replaced with the viewport and capability-based strategies discussed above. We will be removing the dedicated modes in the near future, making “mobile mode” an alias for “viewport width less than sm” for backwards compatibility.

This document is version controlled - suggest changes on github.

9 « J'aime »
2

Donc, quelque chose comme ceci serait déprécié ?

@service site;
...
const mobileView = this.site.mobileView;
3

Si vous le faites dans un contexte statique, alors oui, cela ne sera pas compatible avec le prochain « mode mobile basé sur la fenêtre d’affichage » (actuellement désactivé).

Si vous effectuez la vérification dans un contexte d’auto-suivi comme celui-ci :

@service site;
...

<template>
  {{#if this.site.mobileView}}
    ...
  {{/if}}
</template>

Alors Ember re-rendra automatiquement les choses lorsque la valeur booléenne mobileView changera (c’est-à-dire lorsque le navigateur sera redimensionné). Donc, c’est bon.

4

Pour être sûr, le mettre dans un getter est déprécié, mais pas le mettre dans <template> ?

5

Le mettre dans un getter est également acceptable, car il sera automatiquement suivi par Ember.

@service site;

get shouldRender(){
  return this.site.mobileView;
}


<template>
  {{#if this.shouldRender}}
    ...
  {{/if}}
</template>

^^ ceci est correct

Un mauvais exemple serait

export default apiInitializer((api) => {
  if(api.container.lookup("service:site").mobileView){
    api.renderInOutlet("some-outlet", <template>Mon contenu</template>)
  }
});

Car dans cette situation, mobileView n’est vérifié qu’au démarrage de l’application. Redimensionner le navigateur ne relancera pas l’initialiseur.

Vous refactoriseriez donc vers quelque chose comme

export default apiInitializer((api) => {
  const site = api.container.lookup("service:site");
  api.renderInOutlet("some-outlet", <template>
    {{#if site.mobileView}}Mon contenu{{/if}}
  </template>);
});

Ainsi, les changements apportés à mobileView prendront effet lors du redimensionnement du navigateur.

3 « J'aime »
6

Compris maintenant. Merci pour l’explication !

1 « J'aime »
7

(message supprimé par l’auteur)

1 « J'aime »
8

La recommandation générale est : ne faites pas ça. Pourquoi ce type d’expériences devrait-il différer en fonction de la taille de l’écran ?

Une expérience de pensée utile est : comment vous attendez-vous à ce qu’il se comporte sur les téléphones pliables ou les tablettes, qui ne correspondent pas explicitement aux catégories mobile/bureau.

Si vous souhaitez réellement que ce type de changement de comportement soit basé sur l’agent utilisateur du navigateur (comme fonctionnaient les anciens modes mobile/bureau), alors nous avons capabilities.isMobileDevice, qui vérifie littéralement la présence du mot « mobile » dans la chaîne de l’agent utilisateur :

1 « J'aime »
9

eh bien dans mon cas, c’est que je fournis l’option pour le bureau de basculer la page d’accueil vers la route des intersections de balises - dont l’interface n’existe pas sur mobile… (bien que la route fonctionne réellement - des contrôles supplémentaires sont masqués)

… mais je comprends, je vais probablement y repenser !

1 « J'aime »
10

Intéressant ! Je me demande si c’est intentionnel… J’ai l’impression que cela devrait fonctionner sur n’importe quel appareil :thinking:

2 « J'aime »