react native react mobile font icon - 06 Mar 2018

Intégrer des icônes vectorielles dans React Native

Thomas JARRAND
Écrit par Thomas JARRAND

Comment intégrer des icônes vectorielles dans une app React Native grâce à une police de caractères personnalisée.

Les avantages du vectoriel pour intégrer une suite d’icônes dans une application sont assez nombreux :

Problème

Malheureusement pour nous, React Native ne supporte pas nativement le format SVG, principal format vectoriel que nous utilisons sur le web.

Le développement mobile avec React Native nous contraint donc à fournir chaque illustration en plusieurs exemplaires pour supporter les différentes résolutions d’écrans. Et chaque changement de couleur donne lieu à une nouvelle série d’images pour le même pictogramme.

Solution !

Heureusement pour nous, ce que React Native supporte bien, ce sont les polices de caractères personnalisées.

Et ça tombe bien, car on dispose déjà les outils web qui nous permettent de fournir une suite d’icônes sous forme de police de caractères (également un format vectoriel).

Voici donc les étapes pour intégrer nos icônes SVG dans une application React Native grâce aux polices personnalisées !

Générer une police d’icônes

Pour générer une police de caractères à partir d’icônes au format SVG, plusieurs outils existent déjà. Chez élao, nous travaillons généralement avec IcoMoon.

1 . Créez votre suite d’icônes en sélectionnant parmi les polices proposées et/ou en uploadant vos propres pictogrammes au format SVG.

2 . Cliquez sur Generate Font puis ouvrez les propriétés de la police (à côté du bouton Download) et saisissez un nom pour votre police qui ne contienne que des lettres standards [a-z], minuscules et/ou majuscules (ex : acmeIcon).

3 . Fermez la pop-in pour valider votre changement puis téléchargez votre police grâce au bouton Download. Enfin décompressez le fichier ZIP téléchargé.

4 . Dans le dossier obtenu, récuperez la police au format ttf contenu dans le répertoire fonts et placez-la dans votre projet dans un répertoire de votre choix (ex: ./assets/fonts/acmeIcon.ttf).

⚠️ Note : Attention, pour bien fonctionner sur iOS et Android, le nom du fichier .ttf doit correspondre exactement au nom de la police choisie dans l’étape 2.

Intégrer la police au build React Native

Note : Ici je ne fais que répéter les étapes décrites dans cet article assez complet “React Native Custom Fonts” 🇬🇧

Configurer le build natif

Ajoutez la section suivante à votre package.json :

{
    "rnpm": {
      "assets": ["./assets/fonts/"]
    }
}

Note : ici le chemin doit correspondre au dossier choisi à l’étape 4.

Lier la police

Executez un simple react-native link

Si tout s’est bien passé, vous pouvez voir votre police copiée dans le dossier de ressources Android :

$ ls ./android/app/src/main/assets/fonts
> acmeIcon.ttf

Côté iOS, votre fichier ios/AcmeApp/Info.plist devrait comprendre les nouvelles lignes qui suivent :

<key>UIAppFonts</key>
<array>
  <string>acmeIcon.ttf</string>
</array>

Note : La suite d’icônes est amenée à évoluer durant la vie de votre app. Pour la mettre à jour, remplacez votre fichier ./assets/fonts/acmeIcon.ttf par sa nouvelle version puis exécutez react-native link à nouveau.

Afficher les icônes dans notre app

En CSS, pour afficher une icône à partir d’une police, on s’y prend de la manière suivante :

On définit d’abord une classe pour notre pictogramme et on lui attribue un pseudo-élément contenant le caractère UTF-8 correspondant à l’icône voulue dans la police générée.

.icon-home:before {
  font-family: 'acmeIcon';
  content: "\e902";
}

Puis on l’affiche en HTML comme ceci :

<span class="icon-home"></span>

Côté React Native, l’équivalent de cette technique s’écrirait ainsi :

<Text style={{ fontFamily: 'acmeIcon' }}>{'\u{e902}'}</Text>

💡 Petite subtilité : si le caractère UTF-8 en CSS se note "\e902", en Javascript c’est '\u{e902}'. La partie variable pour chaque icône ici est e902. IcoMoon vous fournit ce code unique pour chaque pictogramme, à vous de l’adapter au format Javascript.

Bien que cette notation fonctionne, je vous propose de créer un composant réutilisable et plus simple à utiliser !

Créer un composant Icon

Nous allons maintenant créer un composant Icon chargé de rendre une icône.

import React, { Component } from 'react';
import PropTypes from 'prop-types';
import { Text, StyleSheet } from 'react-native';

export default class Icon extends Component {
  /**
   * Liste les pictogrames disponibles en faisant correspondre un nom à chaque code UTF8
   */
  static icons = {
    'elao': '\u{e910}',
    'home': '\u{e902}',
    'pencil': '\u{e905}',
    'camera': '\u{e90f}',
  };

  /**
   * On crée un style de base qui utilise notre police personnalisée
   */
  static styles = StyleSheet.create({
    icon: {
      fontFamily: 'acmeIcon',
    },
  });

  static propTypes = () => ({
    // On déclare une propType "icon" qui servira à sélectionner le pictogramme
    icon: PropTypes.oneOf(Object.keys(Icon.icons)).isRequired,
    // On reprend la propType "style" du composant Text
    style: Text.propTypes.style,
  });

  /**
   * Certaines propriétés CSS font bugger l'affichage des polices personnalisées sur Android.
   * Nous préférons donc les exclure des styles à appliquer au pictogramme.
   */
  safeIconStyle(styles) {
    const style = StyleSheet.flatten(styles);

    delete style.fontWeight;

    return style;
  }

  /**
   * On rend un composant Text contenant le pictogramme demandé
   */
  render() {
    const { icons, styles } = this.constructor;
    const { icon, style } = this.props;

    return <Text style={this.safeIconStyle([styles.icon, style])}>{icons[icon]}</Text>;
  }
}

Utilisation du composant Icon

Nous pouvons maintenant afficher des icônes dans notre app comme ceci :

<Icon icon="home" style={{ fontSize: 16, color: 'green' }} />

Note : Le composant Icon se comportera comme le composant Text de React Native, notamment concernant l’héritage des styles lorsqu’il est contenu dans un composant Text stylisé. Voir exemple ci-dessous :

<Text style={styles.title}
  <Icon icon="home"/>
  Retour à l'accueil
</Text>

Et le résultat !


Illustration photo par unsplash-logoHarpal Singh