Jim : Javascript Interactive Microlibrary

Documentation

Javascript Interactive Microframework Jim est une micro-librairie JavaScript qui utilise des événements pour l'interactivité.
JIM

Jim n'est qu'une esquisse, un point de départ d'un projet plus complexe.

L'idée serait d'associer Ajax pour que les possibilités soient infinies.

Jim est une micro-librairie JavaScript qui utilise les événements pour l'interactivité.

Jim propose un système de gestion du clavier permettant d'associer une touche avec une action paramétrable.

Il donc est possible d'accéder à une page précise, que ce soit sur site ou sur le web, ou encore de lancer des animations ou des actions.

Par exemple, donner la possibilité à l'utilisateur de se déconnecter en appuyant sur la touche "Q"...

Jim est fourni sans aucune ligne de code jQuery, ni aucune dépendance...

I - Installation

  1. Ouvrez un terminal, placez-vous dans le dossier de votre projet, puis tapez :
    npm i jim-js
  2. Copiez dans le dossier js (ou javascript) de votre projet le fichier :
    votreProjet/node_modules/jim-js/datas.js
  3. Appelez-le depuis votre layout (ou index) en tant que premier script, Jim venant juste après.

II - Datas

Ce fichier permet de paramétrer les actions que Jim lancera lors de l'appui sur l'une des touches du clavier.

Il s'agit de simples fonctions qui sont appelées & qu'il s'agit de personnaliser pour chaque projet.

Les touches disponibles sont les 26 lettres & les 10 chiffres, ce qui permet donc d'obtenir 36 actions paramétrables.

III - Jim

Il s'agit du fichier principal, il contient la totalité du code non-paramétrable & se découpe en 3 parties : helpers, events & main.

1 / Les Helpers

Les helpers sont des fonctions génériques utilisables dans de nombreux cas ; d'autres helpers viendront très prochainement se rajouter dans cette partie.

2 / Les Events

Les events sont des fonctions appelées lors d'évènements utilisateurs ; la fonction principale étant onKeyDown() permettant la liaison entre les touches du clavier & les actions paramétrables.

3 / Le Main

Le main est la partie principale contenant les ajouts différés, au chargement effectif de la page, d'écouteurs d'évènements.