Set Template

14min
﻿
To modify a Klevu Template,  a new template is created to replace the default instance at a specific position within the interface framework. Then, indicate that Klevu should use the new template in place of the default.
There are three steps:
Identify which micro-template to be replaced
Create the new template
Assign the override for the appropriate template block
﻿
Template Identification
Klevu Theme provides a working implementation of Quick Search, Search Results Landing Page and Category Pages by just including a small JavaScript asset. All of the HTML templates are injected into your page when our JavaScript Library powers up.
In order to make efficient modifications to a template, understanding the structure and syntax will be important.
Template Name
Klevu Template JS is built on a framework of micro-templates. The micro-templates are positioned as reusable components where applicable within the base Klevu framework.
The easiest way to understand this is to enable Template Hints. There are two steps to enable Template Hints:
set a sessionStorage variable by opening your browser's Developer Tools, going to the Console and typing the following command:
sessionStorage.setItem('klv_debugMode', true);
Once you have ran the above command in the Console you can append the parameter klib_global_templateHints=true to your URL.
This will expose the micro-template positioning, each with a red border for context as well as the associated name used for rendering.
e.g:
https://www.yourdomain.com/search/?q=blue&klib_global_templateHints=true

klib_global_templateHints=true
﻿
The micro-templates use this identifier to render components in place by name
For Example, landingProductBadge can be called to render at multiple positions within the default  search templates.
<header ku-block data-block-id="ku_landing_result_item_header">
    <%=helper.render('landingProductBadge', scope, data, dataLocal) %>
</header>
Please see Template Engine﻿  for further details about helper.render and options
﻿
Template ID
The Klevu theme reference script injects the micro-templates onto the webpage. The best way to view the generated templates is using the browser "Inspect Element" developer feature.
Within the website <body> you will find Klevus template <div> container(s) that include the scripted micro-templates.  
The micro-templates will all be of type="template/klevu" and will all contain a unique id
e.g.
<div id="klevu-landing-search-theme-templates" />
 <script type="template/klevu" id="klevuLandingTemplateBase"> ... </script>
 <script type="template/klevu" id="searchResultProductBadge"> ... </script>
. . .
</div>
﻿
Template Assignment
The template id is assigned to the template name during the rendering process.
For example, the default Search Result Page (landing) Template uses the markup within the script  id searchResultProductBadge to render by the name landingProductBadge.
﻿
landingProductBadge
﻿
Note: The render name is not always the same as the default micro-template id
Please see Template Reference﻿ for quick reference chart of template id to  name. As well as detail on how to view the default template markup.
  
Create the New Template
After locating the template you wish to overwrite, it is often easiest to make a copy of the original script block and give the new copy a unique id. Then apply any modifications you like to the new copy.
Please see Template Reference﻿ for detail on how to view the default template markup.
For example, make a copy of the default template for displaying a product badge ... 
<script type="template/klevu" id="searchResultProductBadge">
    <%if(dataLocal.stickyLabelHead && dataLocal.stickyLabelHead != "") { %>
        <div class="kuDiscountBadge">
                <span class="kuDiscountTxt">
                        <%= dataLocal.stickyLabelHead %>
                </span>
        </div>
    <% } %>
</script>
 ... and replace the id to something unique ...
<script type="template/klevu" id="myCustom_searchResultProductBadge">
<% console.log('Klevu dataLocal', dataLocal) %>
    <div class="kuDiscountBadge">
        <span class="kuDiscountTxt">
            SHOW A CUSTOM BADGE!
        </span>
    </div>
</script>
Note: The use of the console.log output for the dataLocal object has been provided here for reference. This is an easy way to review the product attributes available for use within the template on the browsers developer console.
Please see Template Engine﻿ for further details about available data elements and options.
﻿
Assign the Override
Assign the new template id (selector) to the target render name within the Klevu options object using the following format.
...
	{
	 scope: "<scope identifier(s)>", 
	 selector: "<id Of My Template>",
	 name: "<name Of Template To Replace>"
	}
...
e.g.
klevu({
	theme: {
		setTemplates: [
		 {
		  scope: "landing,catnav,quick", 
		  selector: "#idOfMyTemplate",
		  name: "nameOfTemplateToReplace"
		 }
		]
	}
});
Notice how the selector value is actually a CSS selector for your new template. 
Determining Scope
Note that each setTemplates assignment requires definition within the corresponding scope of the override. We will chart these below.
Scope
Description
all
Applies to all scope modules
quick
QuickSearch module
landing
SRLP module
catnav
Category module
full_page
Both SRLP and Category modules (same as "landing,catnav")
﻿
Example
Search landing page micro-template override displaying a custom badge message.
Replaces the default markup at the landingProductBadge position for the landing scope only.
JavaScript
<script type="text/javascript">
/* Assign new templates to Klevu Options */
klevu({
	theme: {
		setTemplates: [
			{
			scope: "landing", // impacted scope
			selector: "#myCustom_searchResultProductBadge", // new markup block ID
			name: "landingProductBadge" // template placement name
			}
		]
	}
});
</script>

<!-- Create a new markup block with a unique 'id' -->
<script type="template/klevu" id="myCustom_searchResultProductBadge">
  <% console.log('Klevu dataLocal', dataLocal) %>
    <div class="kuDiscountBadge">
        <span class="kuDiscountTxt">
            MY CUSTOM BADGE!
        </span>
    </div>
</script>

<script type="text/javascript">
/* Assign new templates to Klevu Options */
klevu({
	theme: {
		setTemplates: [
			{
			scope: "landing", // impacted scope
			selector: "#myCustom_searchResultProductBadge", // new markup block ID
			name: "landingProductBadge" // template placement name
			}
		]
	}
});
</script>

<!-- Create a new markup block with a unique 'id' -->
<script type="template/klevu" id="myCustom_searchResultProductBadge">
  <% console.log('Klevu dataLocal', dataLocal) %>
    <div class="kuDiscountBadge">
        <span class="kuDiscountTxt">
            MY CUSTOM BADGE!
        </span>
    </div>
</script>
﻿
Example
﻿
﻿
﻿
﻿
﻿
Scope	Description
all	Applies to all scope modules
quick	QuickSearch module
landing	SRLP module
catnav	Category module
full_page	Both SRLP and Category modules (same as "landing,catnav")