Componente de Pesquisa rápida quick-search-component

O componente de Pesquisa rápida fornece recursos de pesquisa para um site e apresenta resultados de pesquisa para que os visitantes possam encontrar facilmente o conteúdo correspondente e visualizar os resultados.

TIP
Você já considerou o Edge Delivery Services for AEM?
Você pode continuar usando os métodos descritos neste documento para projetos existentes. No entanto, para novos projetos, a Adobe recomenda utilizar o Edge Delivery Services.

Uso usage

O componente de Pesquisa rápida oferece aos visitantes do site a capacidade de pesquisar conteúdo, visualizar os resultados no local e navegar facilmente até as páginas correspondentes. Novos resultados são buscados dinamicamente à medida que o usuário rola os resultados da pesquisa.

A caixa de diálogo de edição permite que o autor de conteúdo defina onde a pesquisa deve iniciar na árvore de conteúdo e, opcionalmente, oculte a opção Pesquisa Semântica. Usando a caixa de diálogo de design, o autor do modelo pode definir o valor padrão para onde a pesquisa deve começar na árvore de conteúdo, o tamanho máximo do conjunto de resultados, a duração mínima do termo de pesquisa e se a opção Pesquisa semântica será mostrada aos visitantes por padrão.

Versão e compatibilidade version-and-compatibility

A versão atual do componente de Pesquisa rápida é a v3, introduzida com a versão 2.32.0 dos Componentes principais, adicionando uma opção de Pesquisa semântica, e está descrita neste documento.

A tabela a seguir detalha todas as versões compatíveis do componente, as versões do AEM com as quais as versões do componente são compatíveis e os links para a documentação das versões anteriores.

Versão do componente
AEM 6.4
AEM 6.5
AEM 6.5 LTS
AEM as a Cloud Service
v3
-
Compatível*
Compatível*
Compatível
v2
-
Compatível
Compatível
Compatível
v1
Compatível com a
versão 2.17.4 e anteriores
Compatível
-
Compatível

*O botão Pesquisa semântica só está disponível no AEM as a Cloud Service.

Para obter mais informações sobre versões e lançamentos dos Componentes Principais, consulte o documento Versões dos Componentes Principais.

Exemplo de saída do componente sample-component-output

Para experimentar o componente de Pesquisa Rápida, e ver exemplos de suas opções de configuração e de saídas HTML e JSON, visite a Biblioteca de Componentes.

Detalhes técnicos technical-details

NOTE
A proteção do componente de Pesquisa ou de qualquer aplicativo baseado no AEM contra ataques de DOS deve ser implementada em um nível superior, por exemplo, usando mod_security no dispatcher.

A documentação técnica mais recente sobre o Componente de Pesquisa Rápida pode ser encontrada no GitHub.

Mais detalhes sobre o desenvolvimento dos Componentes principais podem ser encontrados na documentação do desenvolvedor dos Componentes principais.

Caixa de diálogo de edição edit-dialog

A caixa de diálogo de edição permite que o autor de conteúdo defina onde a pesquisa deve iniciar na árvore de conteúdo e oculte, opcionalmente, o botão de alternância Pesquisa semântica.

Caixa de diálogo de edição do componente de Pesquisa rápida

Pesquisar raiz - A página raiz de onde a pesquisa deve ser iniciada. A Pesquisar raiz pode ser um blueprint principal, idioma principal ou página regular.

  • ID - Essa opção permite controlar o identificador exclusivo do componente no HTML e na Camada de dados.

    • Caso deixado em branco, um ID exclusivo é gerado automaticamente para você e pode ser encontrado ao inspecionar a página resultante.
    • Se um ID for especificado, é responsabilidade do autor garantir que ele seja exclusivo.
    • A alteração do ID pode afetar o rastreamento de CSS, JS e da Camada de Dados.
  • Ocultar alternância de Pesquisa Semântica nesta instância - Quando marcada, a alternância de Pesquisa Semântica fica oculta, independentemente do que a caixa de diálogo de design está configurada para mostrar.

    • Deixe desmarcada para usar o padrão do modelo.
    • Essa opção não pode forçar o botão de alternância a ser exibido em um local onde a caixa de diálogo de design o oculta.
NOTE
Se a Pesquisar raiz não estiver configurada ou não puder ser resolvida, a Pesquisa rápida assumirá como padrão a pesquisa abaixo da página atual.
NOTE
O botão Pesquisa semântica só retorna resultados alimentados por IA quando o ambiente é configurado com a IA de conteúdo do AEM. Nos ambientes LTS do AEM 6.5 e AEM 6.5 que não estão configurados com a IA de conteúdo, oculte o botão de alternância usando a caixa de diálogo de design para que os visitantes não recebam um modo de pesquisa que não seja funcional.

Caixa de diálogo de design design-dialog

Usando a caixa de diálogo de design, o autor do modelo pode definir o valor padrão para onde a pesquisa deve começar na árvore de conteúdo, bem como o tamanho máximo do conjunto de resultados, a duração mínima do termo de pesquisa e se a opção Pesquisa semântica é exibida aos visitantes por padrão.

Guia Propriedades properties-tab

Caixa de diálogo de design do componente de Pesquisa rápida

  • Raiz de Pesquisa - O valor padrão da raiz de pesquisa quando um autor de conteúdo coloca o Componente de Pesquisa Rápida em uma página de conteúdo

  • Tamanho dos Resultados - O número máximo de resultados obtidos por uma solicitação de pesquisa

  • Tamanho Mínimo do Termo de Pesquisa - Tamanho mínimo do termo de pesquisa para iniciar a pesquisa

  • Ocultar alternância de pesquisa semântica - Quando marcada, a opção Pesquisa semântica descrita em Uso não é mostrada aos visitantes do site por padrão, e o componente se comporta como o componente v2 (somente pesquisa de texto completo).

    • Desmarcado por padrão.
    • Os autores de conteúdo também podem substituir isso por um Componente de Pesquisa rápida individual na caixa de diálogo de edição.
NOTE
O botão Pesquisa semântica só retorna resultados alimentados por IA quando o ambiente é configurado com a IA de conteúdo do AEM. Nos ambientes AEM 6.5 e AEM 6.5 LTS que não estão configurados com a IA de conteúdo, oculte o botão de alternância usando a caixa de diálogo de design para que os visitantes não recebam um modo de pesquisa que não seja funcional.
NOTE
O Tamanho dos resultados e o Tamanho mínimo do termo de pesquisa só podem ser definidos no modo de design e, portanto, somente no nível do modelo, o que significa que os autores de conteúdo não podem modificar esses valores.
CAUTION
O Tamanho dos resultados e o Tamanho mínimo do termo de pesquisa podem ter impacto no desempenho se forem definidos como muito altos ou muito baixos, respectivamente.

Guia Estilos styles-tab

O componente de Pesquisa rápida é compatível com o Sistema de Estilos do AEM.

recommendation-more-help
experience-manager-core-components-help-main-toc