Coveo Hive Renderings List
Coveo Hive Renderings List
This page covers an extensive list of all the renderings provided by Coveo for Sitecore Hive.
Most of the components covered are implementations of existing components from the Coveo JavaScript Search Framework or the Coveo for Sitecore Search Framework.
Analytics
Coveo Analytics
Implements the Analytics component.
Coveo for Sitecore Analytics
Implements the CoveoForSitecoreAnalytics component.
Coveo Page View Analytics
Records view events in the Coveo Analytics service using the coveo.analytics.js module.
Coveo Send Analytics To Sitecore
Implements the SendAnalyticsToSitecore component.
Components
Coveo Did You Mean
Implements the DidYouMean component.
Coveo Pager
Implements the Pager component.
Coveo Query Summary
Implements the QuerySummary component.
Coveo Results Per Page
Implements the ResultsPerPage component.
Coveo Breadcrumbs
Implements the Breadcrumb component.
Coveo Error Report
Implements the ErrorReport component.
Coveo Query Duration
Implements the QueryDuration component.
Coveo Result Layout Selector
Implements the ResultLayoutSelector component.
Coveo Settings Button
Implements the Settings component. You must include components from the Settings Button Options to provide options for this component.
Facets
Coveo Date Facet Range
Implements the FacetRange component with specific fields for dates.
Coveo Date Facet Slider
Implements the FacetSlider component with specific fields for dates.
Coveo Distance Facet Range
Implements the FacetRange component with specific fields for distance.
Coveo Facet
Implements the Facet component.
Coveo Numeric Facet Range
Implements the FacetRange component with specific fields for numeric values.
Coveo Numeric Facet Slider
Implements the FacetSlider component with specific fields for numeric values.
Frames
Default Frame
Layout containing a simple layout with the required placeholder in place.
Modular Frame
Layout containing placeholders to insert sections within the page. Allows very flexible page-building using the Experience Editor.
Modular Frame - 3 columns
Similar to the Modular Frame, but splits the layout into three columns to allow Recommendations on the right of the results list.
Position Providers
Coveo Google API Position Provider
Implements the GoogleApiPositionProvider component.
Coveo Navigator Position Provider
Implements the NavigatorPositionProvider component.
Coveo Sitecore Position Provider
Implements the StaticPositionProvider using Sitecore’s xDB geolocation service.
Resources
Coveo Distance Resources
Implements the CoveoDistanceResources component.
Coveo Search Resources
Adds the required JavaScript and CSS references to use the Coveo Search UI Framework and the Coveo for Sitecore Search UI Components.
Also, implements the CoveoForSitecoreContext component using Sitecore’s context.
Coveo User Context
Provides the CoveoForSitecoreUserContext variable that’s filled with values defines in the component properties.
Allows adding context to view events and Search Interfaces to refine results based on the context.
Result Templates
Coveo File Result Template
Provides a result template for the ResultList component using an on-disk file.
The file must be located in the /templates folder of your Coveo Hive root path, usually located in /Website/Coveo/Hive.
Coveo Item Result Template
Provides a result template for the ResultList component using a field on the item.
The field must be valid HTML that would usually be included in a script tag in a usual Coveo JavaScript Search Framework implementation.
Results List
Coveo Results List
Implements the CoveoResultsList component.
Scopes
Automatic Boosting
Implements the CoveoForSitecoreRankingExpression component using rules defined by the Sitecore xDB profiles.
Each matching profile adds a ranking expression to the query to boost documents that match this profile.
External Content
Implements the CoveoForSitecoreExternalContent component using the defined external sources and collections.
Query Filter
Implements the CoveoForSitecoreFilterExpression component using the defined rules.
Query Ranking
Implements the CoveoForSitecoreRankingExpression component using the defined rules.
Sitecore Instance Filter
Implements the CoveoForSitecoreLocalExpression component.
Search Boxes
Coveo Global Searchbox
Implements the Omnibox component and provides properties to configure it as a global searchbox.
When not within a Search Interface, it’s initialized as a Standalone Search Box, which redirects to the configured search interface.
Coveo Searchbox
Implements the Omnibox component.
Search Interfaces
Coveo Recommendations
Implements the Recommendation component to get Recommendations from the Coveo Machine Learning engine.
This component can be used as a standalone search interface.
Coveo Related Query
Implements the Recommendation component to get a result list related to the one executed in the main search interface.
Its main purpose is to execute a second query for very specific filters, such as “Related Articles” or “Related People” for the given query.
This component can be used as a standalone search interface.
Coveo Search Interface
Implements the SearchInterface component.
Required to use any other Coveo Search UI Framework components.
Sections
Used to granularly change parts of the Search Interface.
Most of them contain styles that affect the layout and their content and placeholders that are used to add the components for that section.
External Components Section
Section that allows registering component for a specific search interface in the page.
This is useful if you already have a layout and want to register components in other sections of the site.
Use with the Coveo Global Searchbox component to automatically register the search box within the Search Interface instead of initializing as a Standalone Search Box.
Facets Section
Section that contains placeholders to insert facets.
Global Search Section
Section that contains placeholders to insert and configure a Global Searchbox and its related components.
Recommendations Section
Section that contains placeholders to insert and configure the Recommendations and Related Query components.
Results Header Section
Section that contains placeholders to insert and configure components that can be added in the header of the ResultsList.
It can contain many components and other sections and is mainly used to granularly change the layout.
Results Layout Section
Section that contains styling and a placeholder to add a Result Layout.
Results Section
Section that contains placeholders to insert and configure ResultsList components and components that can be placed in its header and footer.
Results Sorts Section
Section that contains placeholders to insert and configure Sort components
Results Summary Section
Section that contains placeholders to insert and configure components that show query information.
Search Section
Section that contains placeholders to insert and configure a search box and its related components.
Tabs Section
Section that contains placeholder to insert and configure Tab components.
Settings Button Options
Settings Button Options are options that can be attached to a Settings Button component. They only appear when clicking the Settings button.
Coveo Advanced Search
Implements the AdvancedSearch component.
Coveo Export To Excel
Implements the ExportToExcel component.
Coveo Preferences Panel
Implements the PreferencesPanel component.
The Coveo for Sitecore implementation adds a placeholder that’s used to insert preferences components, such as the ResultsFiltersPreferences component.
Coveo Results Filters Preferences
Implements the ResultsFiltersPreferences component. It must be inserted inside a PreferencesPanel component.
Coveo Results Preferences
Implements the ResultsPreferences component. It must be inserted inside a PreferencesPanel component.
Coveo Share Query
Implements the ShareQuery component.
Sorts
Coveo Date Sort
Implements the Sort component.
In Coveo for Sitecore, it allows the user to pick date fields.
Coveo Distance Sort
Implements the Sort component.
In Coveo for Sitecore, it allows the user to pick distance fields.
Coveo Field Sort
Implements the Sort component.
In Coveo for Sitecore, it allows the user to pick any field that’s defined as a Facet.
Coveo Relevancy Sort
Implements the Sort component configured for Relevancy.
Tabs
Coveo Tab
Implements the Tab component.
The Coveo for Sitecore rendering inserts components that are active only for this specific tab.