js doofinder

Biblioteca Doofinder

Também conhecida como js-doofinder , ou apenas doofinder , esta biblioteca facilita a execução de solicitações ao serviço de pesquisa do Doofinder e personaliza a forma como você apresenta os resultados.

• Instalação
  • Pacote de fios
  • NPM
  • CDN
• DR
• Início rápido
• Documentação

Instalação

A biblioteca pode ser instalada através de gerenciadores de pacotes ou apontando diretamente para um arquivo no CDN do jsDelivr.

Yarnpkg (recomendado)

$ yarn add doofinder

NPM

$ npm install doofinder

MEE

 import { Client } from 'doofinder' ; 

CommonJS

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

CDN

Você pode incluir a biblioteca diretamente em seu site:

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

DR

Se você quer apenas saber como isso está estruturado, sem detalhes, vamos lá.

A biblioteca fornece:

• Uma classe Client para realizar solicitações ao serviço Doofinder.
• Uma classe Query que fornece um objeto fácil de usar para preparar as consultas ao Doofinder Client antes de enviar qualquer coisa.
• Uma classe Result para agrupar a resposta do servidor e acessar os dados por meio de métodos fáceis de usar.
• Um singleton ClientRepo que contém um pool de Client Doofinder em cada zona e ajuda a instanciá-los.

Início rápido

O projeto inclui uma demonstração que você pode usar como inspiração. Para dar uma olhada e ver o que você pode fazer com ele:

1. Baixe o projeto completo do Github.
2. Certifique-se de ter o Node 10.x em execução no seu sistema.
3. Da raiz do projeto:
   1. instale dependências com $ yarn install ou $ npm install .
4. Para executar os testes, execute: $ yarn test .

A marcação demo está dentro de index.html e o código Javascript relacionado pode ser encontrado em playground/demo.js .

AVISO: A demonstração usa um mecanismo de busca de teste, mas você pode usar outro, basta alterar o valor da variável HASHID que você encontrará dentro de index.html .

IMPORTANTE: Doofinder protege chamadas de API com CORS. Se você alterar a variável HASHID definida em index.html você terá que permitir localhost para seu mecanismo de busca no Doofinder Admin.

Como usar a biblioteca

Para se familiarizar com o uso deste projeto, você pode seguir os exemplos fornecidos no playground.

O componente principal é o arquivo demo.js, mas para utilizá-lo de maneira eficaz, você precisará compreender os seguintes parâmetros:

1. servidor: https://docs.doofinder.com/api/search/v6/#section/Basics/Endpoint
2. segredo: https://docs.doofinder.com/api/search/v6/#section/Basics/Authentication
3. hashid: https://docs.doofinder.com/api/search/v6/#section/Basics/Conventions
4. ID da sessão: https://docs.doofinder.com/api/search/v6/#section/Basics/Conventions

Documentação

IMPORTANTE: Este é um trabalho em andamento.

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

Suporte ao navegador

Navegador	Autônomo	Módulo ES
Borda	15+	16+
Firefox	32+	60+
Cromo	55+	61+
Safári	11+	11+
Ópera	42+	48+
Chrome para Android	76+	76+
Firefox para Android	68+	68+
Navegador UC para Android	12.12+	12.12+
Safári para iOS	11+	11+