node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

autofocus

autofocus

autofocus est une libre réimplémentation de Focus V2 (focus-core et focus-components) en Typescript qui utilise MobX comme conteneur de state (à la place de flux ou redux). Son but principal est de proposer le framework le plus simple, efficace et robuste pour effectuer les mêmes tâches que le Focus original, tout en restant proche au niveau de l'API et de la structure de l'application (à l'inverse de Focus V3 qui propose une approche différente). Pour ne pas non plus trop s'éparpiller, autofocus dépend de focus-components@3.0.

Typescript

Typescript est un superset typé du Javascript courant (ES2016+). Il vient avec son propre compilateur qui effectue, comme son nom l'indique, du typage statique via de l'inférence (ie. automatiquement) ou des annotations explicites. Son usage est totalement facultatif (il n'est pas nécessaire d'utiliser du Typescript pour consommer la librairie) et totalement "à la carte" (il n'est pas nécessaire d'utiliser du typage partout). Néanmoins, la surcouche est suffisament fine et intuitive pour ne pas causer une surcharge de travail notable (le "langage" peut s'apprendre en 2 heures) et les bénéfices peuvent être énormes, du moins si on se décide à utiliser les options les plus strictes.

Il n'est pas non plus nécessaire d'avoir des libraries en Typescript pour faire du Typescript puisqu'il est possible d'écrire des définitions de librairies (la plupart sont déjà écrites et disponibles sur npm) pour décrire l'architecture de n'importe quel code Javascript. Il n'est pas non plus nécessaire d'utiliser Typescript pour profiter de ses bénéfices, puisqu'en utilisant un éditeur/IDE adapté comme Visual Studio Code, le service de langage Typescript (qui fournit l'autocomplétion, la navigation...) est également activé par défaut pour le Javascript.

Quelque soit votre intérêt dans Typescript (j'espère vous avoir convaincu !), le fait qu'autofocus soit écrit en Typescript est un plus indéniable.

Je vous renvoie à l'excellente documentation pour vous lancer (si ce n'est déjà fait).

MobX

En 2 phrases

MobX permet de définir des objets JS (objet, array, map...) comme observables, qui seront ensuite observés par des fonctions agissant comme des observers (par exemple la fonction render() d'un composant React). Ces fonctions vont déduire automatiquement, à l'exécution, de quelles observables elles dépendent, ce qui permettra à MobX de les réexécuter à chaque fois que l'une d'entre-elle à été modifiée dans l'ensemble de l'application.

C'est magique

Ce qu'il faut bien comprendre, pour l'intégration avec React, c'est que ces réactions se produisent indépendamment des props ou du state du composant !

Ca veut dire qu'on n'a plus besoin :

  • de mixins/classes de base pour injecter de l'état dans le state, ou de composants d'ordre supérieur pour injecter dans les props : on peut utiliser directement cet état dans un composant et l'abonnement est automatique, au prix d'un misérable petit décorateur (ou fonction) @observer sur le composant.
  • de state React local dans un composant. Une simple propriété de classe marquée d'un @observable suffit. Fini le setState asynchrone (et c'est mieux comme ça). Cela veut dire que l'intégralité du state d'une application peut (et devrait) être stocké dans des observables MobX, ce qui permet de tout gérer de la même manière.
  • de dispatcher: on modifie directement l'observable (qui est peut être un objet, un array, une map ou une primitive boxée) et tout sera mis à jour automatiquement. Du coup, on pourrait définir des actions, mais ce ne serait que de bêtes fonctions dans lesquelles on effectuerait des modifications de state.
  • d'une structure rigide centralisée pour contenir le state. Que ça soit un CoreStore de focus-core ou le store redux, plus besoin, les observables sont trackées par MobX quelque soit la manière ou l'endroit où elles ont été définies.

La doc est ici.

Ce qu'il y a dans autofocus

Pour résumé, autofocus, c'est :

  • Une version modifiée de focus-core v2 pour Typescript et MobX
  • Les composants "dépréciés" de focus-components v2 (layout, listes et recherche), modifiés pour Typescript et MobX (ces composants ont été réécrits de zéro pour Focus v3 et se trouvent dans les modules correspondants)
  • Une nouvelle gestion de l'état des formulaires (le reste fonctionne à peu près comme Focus V2), réalisée grâce à MobX, qui facilite beaucoup l’usage et réduit la configuration nécessaire. Ce nouveau module est entièrement testé unitairement.
  • Un nouveau routeur, qui simplifie et synchronise l'état de l'application avec l'URL, réalisé avec MobX.

La doc est disponible ici