js doofinder

Bibliothèque Doofinder

AKA js-doofinder , ou simplement doofinder , cette bibliothèque facilite l'exécution de requêtes auprès du service de recherche de Doofinder et personnalise la façon dont vous présentez les résultats.

• Installation
  • Filpkg
  • MNP
  • CDN
• TL;DR
• Démarrage rapide
• Documentation

Installation

La bibliothèque peut être installée via les gestionnaires de packages ou pointant directement vers un fichier dans le CDN de jsDelivr.

Paquet de fils (recommandé)

$ yarn add doofinder

MNP

$ npm install doofinder

MES

 import { Client } from 'doofinder' ; 

CommonJS

 const { Client } = require ( 'doofinder/commonjs' ) ;

CDN

Vous pouvez inclure la bibliothèque directement dans votre site Web :

 <!-- Javascript -->
< script src =" //cdn.jsdelivr.net/npm/doofinder@latest/dist/doofinder.min.js " > </ script > 

TL;DR

Si vous voulez seulement savoir comment cela est structuré, sans les détails, c'est parti.

La bibliothèque propose :

• Une classe Client pour effectuer des requêtes au service Doofinder.
• Une classe Query qui fournit un objet facile à utiliser pour préparer les requêtes au Client Doofinder avant d'envoyer quoi que ce soit.
• Une classe Result pour envelopper la réponse du serveur et accéder aux données via des méthodes faciles à utiliser.
• Un singleton ClientRepo qui contient un pool de Client Doofinder dans chaque zone et aide à les instancier.

Démarrage rapide

Le projet comprend une démo que vous pouvez utiliser comme source d'inspiration. Pour jeter un œil et voir ce que vous pouvez faire avec :

1. Téléchargez l'intégralité du projet depuis Github.
2. Assurez-vous que Node 10.x est exécuté sur votre système.
3. Depuis la racine du projet :
   1. installez les dépendances avec $ yarn install ou $ npm install .
4. Pour exécuter les tests, exécutez : $ yarn test .

Le balisage de démonstration se trouve dans index.html et le code Javascript associé peut être trouvé sur playground/demo.js .

AVIS : La démo utilise un moteur de recherche de test mais vous pouvez en utiliser un autre, modifiez simplement la valeur de la variable HASHID que vous trouverez dans index.html .

IMPORTANT : Doofinder protège les appels API avec CORS. Si vous modifiez la variable HASHID définie dans index.html vous devrez autoriser localhost pour votre moteur de recherche dans Doofinder Admin.

Comment utiliser la bibliothèque

Pour vous familiariser avec l'utilisation de ce projet, vous pouvez suivre les exemples fournis dans la cour de récréation.

Le composant clé est le fichier demo.js, mais pour l'utiliser efficacement, vous devez comprendre les paramètres suivants :

1. serveur : https://docs.doofinder.com/api/search/v6/#section/Basics/Endpoint
2. secret : https://docs.doofinder.com/api/search/v6/#section/Basics/Authentication
3. hashid : https://docs.doofinder.com/api/search/v6/#section/Basics/Conventions
4. ID de session : https://docs.doofinder.com/api/search/v6/#section/Basics/Conventions

Documentation

IMPORTANT : Il s'agit d'un travail en cours.

https://doofinder.github.io/js-doofinder/

Prise en charge du navigateur

Navigateur	Autonome	Module ES
Bord	15+	16+
Firefox	32+	60+
Chrome	55+	61+
Safari	11+	11+
Opéra	42+	48+
Chrome pour Android	76+	76+
Firefox pour Android	68+	68+
Navigateur UC pour Android	12.12+	12.12+
Safari pour iOS	11+	11+