Composant Recherche rapide quick-search-component

Le composant Recherche rapide fournit des fonctionnalités de recherche à un site web et présente les résultats de recherche afin que les visiteurs puissent facilement trouver le contenu correspondant et afficher les résultats.

TIP
Avez-vous envisagé Edge Delivery Services pour AEM ?
Vous pouvez continuer à utiliser les méthodes décrites dans ce document pour les projets existants. Toutefois, pour les nouveaux projets, Adobe recommande d’utiliser Edge Delivery Services.

Utilisation usage

Le composant Recherche rapide permet aux visiteurs du site de rechercher du contenu, d’afficher les résultats en place et de naviguer facilement vers les pages correspondantes. De nouveaux résultats sont extraits dynamiquement lorsque l’utilisateur fait défiler les résultats de la recherche.

La boîte de dialogue Modifier permet à l’auteur de contenu de définir l’emplacement où doit commencer la recherche dans l’arborescence de contenu et éventuellement de masquer le bouton bascule Recherche sémantique . À l’aide de la ​ boîte de dialogue de conception ​, l’auteur du modèle peut définir la valeur par défaut pour laquelle, dans l’arborescence de contenu, la recherche doit commencer, la taille maximale du jeu de résultats, la longueur minimale du terme et si le bouton (bascule) Recherche sémantique s’affiche par défaut pour les visiteurs.

Version et compatibilité version-and-compatibility

La version actuelle du composant Recherche rapide est v3, qui a été introduite avec la version 2.32.0 des composants principaux en ajoutant un bouton (bascule) Recherche sémantique facultatif. Elle est décrite dans ce document.

Le tableau ci-après présente en détail toutes les versions prises en charge du composant, les versions AEM avec lesquelles les versions du composant sont compatibles et les liens vers la documentation pour les versions précédentes.

Version du composant
AEM 6.4
AEM 6.5
AEM 6.5 LTS
AEM as a Cloud Service
v3
-
Compatible*
Compatible*
Compatible
v2
-
Compatible
Compatible
Compatible
v1
Compatible avec la
version 2.17.4 et versions antérieures
Compatible
-
Compatible

*Le bouton (bascule) Recherche sémantique n’est disponible qu’avec AEM as a Cloud Service.

Pour plus d’informations sur les versions et les publications des composants principaux, voir le document Versions des composants principaux.

Exemple de sortie de composant sample-component-output

Pour tester le composant Recherche rapide et obtenir des exemples d’options de configuration, ainsi que des sorties HTML et JSON, consultez la bibliothèque de composants.

Détails techniques technical-details

NOTE
La protection du composant Recherche ou de toute application basée sur AEM par rapport aux attaques DOS doit être implémentée à un niveau supérieur, par exemple à l’aide de mod_security sur le Dispatcher.

La documentation technique la plus récente sur le composant Recherche rapide est disponible sur GitHub.

Vous trouverez plus d’informations sur le développement des composants principaux dans la documentation relative au développement des composants principaux.

Boîte de dialogue de modification edit-dialog

La boîte de dialogue de modification permet à l’auteur de contenu de définir l’emplacement où doit commencer la recherche dans l’arborescence de contenu et, éventuellement, de masquer le bouton bascule Recherche sémantique .

Boîte de dialogue de modification du composant Recherche rapide

Rechercher à la racine - Page racine d’où lancer la recherche. Rechercher à la racine peut être un gabarit principal, une page principale ou une page normale.

  • ID : cette option permet de contrôler l’identifiant unique du composant dans le code HTML ainsi que dans la couche de données.

    • Si rien n’est indiqué, un ID unique est généré automatiquement et peut être trouvé en examinant la page obtenue.
    • Si un ID est spécifié, il incombe à l’auteur de s’assurer qu’il est unique.
    • La modification de l’ID peut avoir un impact sur le suivi CSS, JS et de couche de données.
  • Masquer le bouton (bascule) Recherche sémantique sur cette instance - Lorsque cette case est cochée, le bouton (bascule) Recherche sémantique est masqué, quelle que soit la fonction que la boîte de dialogue de conception est configurée pour afficher.

    • Ne cochez pas cette case pour utiliser la valeur par défaut du modèle.
    • Cette option ne peut pas forcer l’affichage du bouton bascule à un emplacement où la boîte de dialogue de conception le masque.
NOTE
Si la Racine de la recherche n’est pas configurée ou ne peut pas être résolue, la recherche rapide effectue par défaut une recherche sous la page active.
NOTE
Le bouton Recherche sémantique ne renvoie des résultats optimisés par l’IA que lorsque l’environnement est configuré avec l’IA dédiée au contenu AEM. Dans les environnements LTS AEM 6.5 et AEM 6.5 qui ne sont pas configurés avec l’IA dédiée au contenu, masquez le bouton bascule à l’aide de la boîte de dialogue de conception afin que les visiteurs ne se voient pas proposer un mode de recherche qui ne fonctionne pas.

Boîte de dialogue de conception design-dialog

À l’aide de la boîte de dialogue de conception, l’auteur du modèle peut définir la valeur par défaut pour laquelle, dans l’arborescence de contenu, la recherche doit commencer, ainsi qu’une taille maximale de jeu de résultats, la longueur minimale du terme de recherche et si le bouton (bascule) Recherche sémantique s’affiche par défaut pour les visiteurs.

Onglet Propriétés properties-tab

Boîte de dialogue de conception du composant Recherche rapide

  • Racine de recherche - Valeur par défaut de la racine de recherche lorsqu’un auteur de contenu place le composant Recherche rapide sur une page de contenu

  • Taille des résultats - Nombre maximal de résultats récupérés par une requête de recherche

  • Longueur minimale du terme de recherche - Longueur minimale du terme de recherche pour démarrer la recherche

  • Masquer le bouton (bascule) de recherche sémantique - Lorsque cette case est cochée, le bouton (bascule) Recherche sémantique décrit dans Utilisation n’est pas affiché par défaut pour les visiteurs du site. En outre, le composant se comporte comme le composant v2 (recherche en texte intégral uniquement).

    • Décoché par défaut.
    • Les auteurs de contenu peuvent également remplacer cette propriété pour un composant Recherche rapide individuel dans la boîte de dialogue modifier.
NOTE
Le bouton Recherche sémantique ne renvoie des résultats optimisés par l’IA que lorsque l’environnement est configuré avec l’IA dédiée au contenu AEM. Sur les environnements LTS AEM 6.5 et AEM 6.5 qui ne sont pas configurés avec l’IA dédiée au contenu, masquez le bouton à l’aide de la boîte de dialogue de conception afin que les visiteurs ne se voient pas proposer un mode de recherche qui n’est pas fonctionnel.
NOTE
La Taille des résultats et la Longueur minimum du terme de recherche ne peuvent être définies qu’en mode conception et, par conséquent, au niveau du modèle, ce qui signifie que les auteurs de contenu ne peuvent pas modifier ces valeurs.
CAUTION
La Taille des résultats et la Longueur minimale du terme de recherche peuvent avoir un impact sur les performances si elles sont trop élevées ou trop faibles, respectivement.

Onglet Styles styles-tab

Le composant Recherche rapide prend en charge le système de style AEM.

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