SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

282 Plugins, 197 contribs sur SPIP-Zone, 221 visiteurs en ce moment

Accueil > Outils pour plugins > jQuery UI > Réaliser un champ de formulaire avec autocomplétion avec jQuery (...)

Réaliser un champ de formulaire avec autocomplétion avec jQuery UI

27 février 2013 – par erational – commentaires

15 votes

Ceci est une « contribution pédagogique », qui montre par l’exemple comment développer une nouvelle fonctionnalité pour SPIP.

Cet article est un tutoriel pour montrer la simplicité d’intégration de jQuery UI dans SPIP 3.

Dans un premier temps, nous allons intégrer tout le code « à la main » pour analyser le mode de fonctionnement. En fin d’article on proposera la même solution via le plugin Sélecteur générique qui propose la même solution d’une façon standard et générique.

Sur le même sujet, consulter l’article qui explique la façon d’intégrer jQuery UI dans vos plugins

Objectif

Le but est de réaliser un champs de formulaire avec auto-complétion.

Il existe plusieurs solutions compatible avec jQuery comme AutoComplete, typeahead.js. Nous allons retenir celle fournie par Jquery UI qui a l’avantage d’être intégrée nativement dans SPIP 3.

En savoir plus : Page de documentation du widget jQuery UI Autocomplete

Étape 1 : Charger jQuery UI Autocomplete

Comme beaucoup de plugins javascript, il convient de charger les feuilles de style et les scripts. En SPIP 3, jQuery UI est fourni sous forme d’un plugin du noyau nommé plugins-dist/jquery_ui

Éditer dans votre page squelette en ajoutant les lignes suivantes

  1. <head>
  2. ...
  3. <script type="text/javascript" src="#CHEMIN{prive/javascript/ui/jquery-ui.js}"></script>
  4. <script type="text/javascript" src="#CHEMIN{prive/javascript/ui/jquery.ui.autocomplete.js}"></script>
  5. <link rel="stylesheet" href="[(#CHEMIN{css/jquery-ui.css})]" type="text/css" media="all" />
  6. ...
  7. </head>

Télécharger

Inutile d’ajouter jQuery qui sera chargé automatiquement via la balise #INSERT_HEAD

Étape 2 : Préparer les données

Le plugin est chargé. Il faut maintenant alimenter l’auto-complétion par une liste de mots qui sera appelée lorsque l’utilisateur tapera un mot

Cette page lorsqu’on lui soumet la requête « pie » devra retourner tous les mots contenant ces lettres comme pierrot, homo sapiens, pie noire ....

Nous allons, par exemple, lister tous les mots-clés du site en créant une page autocomplete.html

  1. [(#REM) noisette ajax pour fournir une liste de mots
  2. l'autocompletion jQuery UI autocomplete
  3.  
  4. parametre
  5. - term : lettre cherchee
  6.  
  7. ]#HTTP_HEADER{Content-Type: text/plain; charset=#CHARSET}
  8. [<BOUCLE_mots(MOTS){titre LIKE %#ENV{term}%}{par titre}{","}{0,10}>{"id":#ID_MOT,"label":[(#TITRE|json_encode)],"value":[(#TITRE|json_encode)]}</BOUCLE_mots>]

Télécharger

Explications

  • La balise #HTTP_HEADER permet de forcer le Mime-type et d’empêcher l’affichage des boutons
  • La boucle MOTS effectue une recherche avec le critère LIKE qui permet d’avoir un joker
  • La syntaxe est en format JSON, ce qui implique de séparer les résultats par des virgules {","} et d’encoder les balises SPIP avec le filtre json_encode

Selon vos besoins, il faudra personnaliser cette page qui alimente la liste de mots.

Étape 3 : Appeler l’auto-complétion sur votre champs de formulaire

Il faut maintenant appeler le plugin sur un objet de la page, par exemple, le formulaire de recherche et son champs principal qui possède l’id recherche

L’appel se fait en javascript, par exemple en ajoutant dans votre head, le code suivant :

  1. <head>
  2. ...
  3. <script type="text/javascript">
  4. $(function() {
  5. $( "#recherche").autocomplete({
  6. source: "spip.php?page=autocomplete",
  7. minLength: 2,
  8. });
  9. });
  10. </script>
  11. ...
  12. </head>

Télécharger

Explications
On appelle la page listant les mots avec le paramètre minLength qui permet de déclencher les appels uniquement à partir de la 3e lettre tapée (pour éviter d’épuiser inutilement le serveur).

Voilà l’autocomplétion est en place !


Alternative : Réaliser la même chose avec le plugin sélecteur générique

La plugin Sélecteur générique propose de faire le travail à votre place. Pour pouvoir l’utiliser dans la partie publique, installer au préalable le plugin Sélecteur publique (à télécharger sur cet article)

Ensuite l’autocomplétion est extrêmement simplement à mettre en place

Sur votre champ input, ajouter l’attribut data-selecteur

Créer une page dans votre répertoire squelettes/selecteurs/patate.html

  1. #HTTP_HEADER{Content-Type: text/plain; charset=#CHARSET}
  2. [(#REM)
  3.  
  4. noisette ajax pour fournir une liste de mots
  5. l'autocompletion jQuery UI autocomplete via le plugin selecteur generique
  6.  
  7. parametre:
  8. - q : recherche
  9.  
  10. ][<BOUCLE_mots(MOTS){titre LIKE %#ENV{q}%}{par titre}{","}{0,10}>{"id":#ID_MOT,"label":[(#TITRE|json_encode)],"value":[(#TITRE|json_encode)]}</BOUCLE_mots>]

Télécharger

Pour en savoir plus sur le commit d’intro du sélecteur générique et aussi Sélecteur générique

Retour en haut de la page

Vos commentaires

  • Le 6 juin 2014 à 11:31, par tcharlss En réponse à : Réaliser un champ de formulaire avec autocomplétion avec jQuery UI

    Un article super pratique qui m’a bien dépanné, merci.
    J’ai quand même des remarques sur 2 points :

    1) Dans le script activant l’autocomplétion, il vaut mieux utiliser la balise #URL_PAGE{autocomplete}.
    J’ai d’abord utilisé l’url spip.php?page=autocomplete comme indiqué dans l’exemple, mais ça ne marchait pas : il manquait le « ../ » au début. Ca dépend peut-être des cas de figure, en tout cas avec la balise #URL_PAGE on est sûr d’avoir la bonne adresse.

    2) Pour charger les scripts jquery ui, il y a la pipeline jqueryui_plugins qui permet d’éviter de charger les scripts en doublons.
    Dans mes_options.php :

    1. $GLOBALS['spip_pipeline']['jqueryui_plugins'] .= "|jqueryui_autocomplete";
    2. function jqueryui_autocomplete($scripts){
    3. $scripts[] = 'jquery.ui.autocomplete';
    4. return $scripts;
    5. }

    Télécharger

    • Le 5 février à 11:51, par Raphaël En réponse à : Réaliser un champ de formulaire avec autocomplétion avec jQuery UI

      Bonjour,

      Je remercie Tchariss pour sa remarque - merci également et bien sûr à erational - car l’ajout de la pipeline dans mes_options.php est effectivement la meilleure solution.

      En effet, l’ajout des bibliothèques / scripts directement dans le head ne suffisait pas : le sélecteur - et donc la position du menu des propositions - n’étant pas récupérée.

    Répondre à ce message

  • Le 23 avril 2014 à 19:35, par Billou En réponse à : Réaliser un champ de formulaire avec autocomplétion avec jQuery UI

    Ah finalement j’ai un léger soucis, je me retrouve avec des devant les : qui sont dans les titres des mots-clés listés par l’autocomplete…

    Une idée là-dessus ?

    • Le 23 avril 2014 à 22:25, par Billou En réponse à : Réaliser un champ de formulaire avec autocomplétion avec jQuery UI

      J’ai trouvé comment résoudre le soucis :

      Dans autocomplete.html, avant d’encodre en json, j’applique un filtre textebrut :

      [(#REM) noisette ajax pour fournir une liste de mots
            l'autocompletion jQuery UI autocomplete

           parametre
           - term :    lettre cherchee

      ]#HTTP_HEADER{Content-Type: text/plain; charset=#CHARSET}
      [<BOUCLE_mots(MOTS){titre LIKE %#ENV{term}%}{par titre}{","}{0,10}>{"id":#ID_MOT,"label":[(#TITRE|textebrut|json_encode)],"value":[(#TITRE|textebrut|json_encode)]}</BOUCLE_mots>]
    • Le 2 février à 11:13, par Fredéric En réponse à : Réaliser un champ de formulaire avec autocomplétion avec jQuery UI

      J’ai aussi eu recours à cette syntaxe car l’encodage des apostrophes n’était pas correct, j’obtenais aujourd&#8217;hui au lieu du texte aujourd'hui.

      Est-ce normal, ou y’a-t-il un paramètre à préciser ?

    Répondre à ce message

  • Le 16 septembre 2014 à 14:55, par En réponse à : Réaliser un champ de formulaire avec autocomplétion avec jQuery UI

    Est-ce que cela est fonctionnel en Spip 2.1 ?

    Répondre à ce message

  • Le 23 avril 2014 à 18:41, par Billou En réponse à : Réaliser un champ de formulaire avec autocomplétion avec jQuery UI

    Très bon merci ! J’utilisais le même mais avec une solution de base avec la doc JQuery, mais toute la liste des mots-clés s’affichait dans le code source des pages… Grâce à cette méthode, plus de soucis de ce genre.

    Répondre à ce message

Répondre à cet article

Qui êtes-vous ?
  • [Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • SPIPr

    23 mars – 36 commentaires

    SPIPr est à la fois une famille de squelettes et un framework pour le développement front avec SPIP. Prêt à l’emploi, thémable, responsive, et conçu dans une approche d’industrialisation et de développement rapide. Documentation source : (...)

  • Escal-V3

    16 février 2012 – 253 commentaires

    Un jeu de squelettes proposant un affichage en 2 ou 3 colonnes avec un large choix de noisettes à insérer ou pas, fortement paramétrable depuis l’espace privé . Présentation A l’instar de sa petite soeur plugin Escal-V2 dont elle reprend toutes les (...)

  • Plugin séances

    10 octobre 2010 – 79 commentaires

    Dans la gestion d’événements, il arrive d’avoir à mettre en rapport un spectacle (film, concert ou autre), un lieu et une date. Il est alors possible d’envisager plusieurs modes de présentation : pour un spectacle donné, les dates et lieux de celui-ci, (...)

  • Les crayons

    23 avril 2008 – 754 commentaires

    Ce plugin permet d’éditer les contenus sur les pages publiques du site, sans passer par l’espace privé de SPIP.

  • Configurer le menu principal de Zpip

    27 décembre 2009 – 34 commentaires

    Le squelette Zpip contient par défaut une barre de navigation minimaliste. Voici le mode d’emploi pour la personnaliser. Avec le plugin Menus Zpip et le plugin Menus sont conçus pour fonctionner ensemble. Pour configurer la barre de navigation (...)