Customize search results in Vue.js

Overview

All components in the Vue.js suite are extendable and can be modified to handle custom layout, styles and behavior. This is possible due to the built-in capability of the platform to attach templates as script tag and therefore supplying a dynamic structure of the presentation.

Goal

This document provides information regarding template extension of the Hawksearch results widget and it’s layout and style customization capabilities.

Prerequisite

Steps of extending the base template

1. Open the results active widget template for editing. It is located in Mvc\Views\Hawksearch\Hawksearch.Default.cshtml. If a resource package is used, then edit the same path in the ResourcePackages folder. Make sure that this is the correct template.

2. Place the script tag containing the component’s overridden template in the file.

3. Save, rebuild and refresh the page.

Template overrides examples

• Overriding the result item component with two column layout using bootstrap classes

  1. Navigate to the directory of the current active widget template (e.g. Mvc\Views\Hawksearch\Hawksearch.Default.cshtml or the relevant resource package).

  2. Copy the file of the base template and name it accordingly (Hawksearch.TwoColumns.cshtml for example).

  3. Edit the file adding or replacing the template override for result item:

     <script id="vue-hawksearch-result-item" type="x-template">
         <div class="row">
             <div class="col-md-6">
                 <div><h3>{{ getField('title') }}</h3></div>
                 <div>{{ getField('info') }}</div>
             </div>
             <div class="col-md-6">
                 <div>{{ getField('content') }}</div>
             </div>
         </div>
     </script>

     Apply the desired structure in this format. All indexed fields are accessible through getField().

  4. Include the file in the project and make it an Embedded resource in the Visual Studio solution.

  5. Save, build and reload the site.

  6. Open the widget designer for Hawksearch results widget on the designated page and select the newly created template from the select list . Save and publish the page. Configuring Hawksearch results widget

• Overriding the result item component to include images and links

  1. Navigate to the directory of the current active widget template (e.g. Mvc\Views\Hawksearch\Hawksearch.Default.cshtml or the relevant resource package).

  2. Copy the file of the base template and name it accordingly (Hawksearch.Gallery.cshtml for example).

  3. Edit the file adding or replacing the template override for result item:

     <script id="vue-hawksearch-result-item" type="x-template">
         <div>
             <a :href="getField('url')">
                 <img :src="getField('image')">
             </a>
             <p>{{ getField('description') }}</p>
         </div>
     </script>

     Apply the desired structure in this format. All indexed fields are accessible through getField(). Note the syntax of binding the attributes (no {{ }} and : placed before the attribute).

  4. Include the file in the project and make it an Embedded resource in the Visual Studio solution.

  5. Save, build and reload the site.

  6. Open the widget designer for Hawksearch results widget on the designated page and select the newly created template from the select list . Save and publish the page. Configuring Hawksearch results widget

• Extending search results view to show additional fields based on the type of the result item

  1. Navigate to the directory of the current active widget template (e.g. Mvc\Views\Hawksearch\Hawksearch.Default.cshtml or the relevant resource package).

  2. Copy the file of the base template and name it accordingly (Hawksearch.ContentTypeDynamicItems.cshtml for example).

  3. Edit the file adding or replacing the template override for result item:

     <script id="vue-hawksearch-result-item" type="x-template">
         <div>
             <template v-if="getField('contenttype') == 'Telerik.Sitefinity.Events.Model.Event'">
                 <div><h3>{{ getField('title') }}</h3></div>
                 <div><img :src="getField('image')"></div>
                 <div>{{ getField('content') }}</div>
             </template>
             <template v-else-if="getField('contenttype') == 'Telerik.Sitefinity.News.Model.NewsItem'">
                 <div><h3>{{ getField('title') }}</h3></div>
                 <div>{{ getField('summary') }}</div>
                 <p><a :href="getField('link')">Read more</a></p>
             </template>
             <template v-else>
                 <div>{{ getField('content') }}</div>
             </template>
         </div>
     </script>

     Apply the desired structure in this format. All indexed fields are accessible through getField(). Vue.js directives are applicable in the template override ( Vue.js Directives )

  4. Include the file in the project and make it an Embedded resource in the Visual Studio solution.

  5. Save, build and reload the site.

  6. Open the widget designer for Hawksearch results widget on the designated page and select the newly created template from the select list . Save and publish the page. Configuring Hawksearch results widget

• Extending result item component to include a field from the response object

  1. Navigate to the directory of the current active widget template (e.g. Mvc\Views\Hawksearch\Hawksearch.Default.cshtml or the relevant resource package).

  2. Copy the file of the base template and name it accordingly (Hawksearch.SearchResponseFieldItem.cshtml for example).

  3. Edit the file adding or replacing the template override for result item:

     <script id="vue-hawksearch-result-item" type="x-template">
         <div>
             <div><h3>{{ getField('title') }}</h3></div>
             <div>{{ getField('content') }}</div>
             <input type="hidden" :value="getResponseField('TrackingId')">
         </div>
     </script>

     Note, that there is an input with a specific method invoked. Using getResponseField(), the value of the TrackingId field is passed to an element placed inside the component. The method takes the field name as a parameter. In this case, it is on the top level of the response object:

     {
         "Facets": [
             ...
         ],
         "VisitorTargets": [
             {
                 "Id": 9356,
                 "Name": "International"
             },
             {
                 "Id": 10187,
                 "Name": "awe"
             }
         ],
         "TrackingId": "87ac0720-a61c-4ba7-93d6-77835c60e67c",
         "Success": true,
         "Pagination": {
     		...
         },
         "Keyword": "",
         "Results": [
             ...
         ],
         "Selections": {},
         "Sorting": {
             ...
         },
         "Redirect": {},
         "Merchandising": {
             ...
         },
         "FeaturedItems": {
             ...
         },
         "SearchDuration": 34
     }

     Deeper properties can also be accessed:

     <input type="hidden" :value="getResponseField('VisitorTargets.0.Name')">

  4. Include the file in the project and make it an Embedded resource in the Visual Studio solution.

  5. Save, build and reload the site.

  6. Open the widget designer for Hawksearch results widget on the designated page and select the newly created template from the select list . Save and publish the page. Configuring Hawksearch results widget

• Extending pagination tool with custom markup

  1. Navigate to the directory of the current active widget template (e.g. Mvc\Views\Hawksearch\Hawksearch.Default.cshtml or the relevant resource package).

  2. Copy the file of the base template or select an existing one.

  3. Edit the file adding or replacing the template override for the pager component:

     <script id="vue-hawksearch-pager" type="x-template">
         <div class="hawk-pagination__controls">
             <button class="hawk-pagination__item" v-on:click="goToPreviousPage">
                 <left-chevron-svg icon-class="hawk-pagination__left" />
             </button>
             <input type="number" :value="page" v-on:change="onChange" class="hawk-pagination__input" />
             <span class="hawk-pagination__total-text">
             	<span class="break"></span>
             	 
             	 of {{ totalPages }} 
     
             	 <template v-if="totalPages > 1">
             	 	pages
             	 </template>
             	 <template v-else>
             	 	page
             	 </template>
             </span>
             <button class="hawk-pagination__item" v-on:click="goToNextPage">
                 <right-chevron-svg icon-class="hawk-pagination__right" />
             </button>
         </div>
     </script>

     Apply the desired structure in this format. The example above adds the contextualized “page“ or “pages“ string after the total pages parameter. Keep in mind that the value and event bindings are required for the proper functioning of the component. Handle their placement with caution.

  4. Include the file in the project and make it an Embedded resource in the Visual Studio solution.

  5. Save, build and reload the site.

General info