| layout | post |
|---|---|
| title | Templates in |
| description | Learn here all about Templates in Syncfusion |
| platform | ej2-javascript |
| control | Templates |
| publishingplatform | |
| documentation | ug |
| domainurl |
The DropDownList has been provided with several options to customize each list item, group title, selected value, header, and footer elements. It uses the Essential JS 2 Template engine to compile and render the elements properly.
The content of each list item within the DropDownList can be customized with the help of itemTemplate property.
In the following sample, each list item is split into two columns to display relevant data's.
{% if page.publishingplatform == "typescript" %}
{% tabs %} {% highlight ts tabtitle="index.ts" %} {% include code-snippet/dropdownlist/item-template-cs1/index.ts %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/item-template-cs1/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/item-template-cs1" %}
{% elsif page.publishingplatform == "javascript" %}
{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/dropdownlist/item-template-cs1/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/item-template-cs1/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/item-template-cs1" %} {% endif %}
The currently selected value that is displayed by default on the DropDownList input element can be customized using the valueTemplate property.
In the following sample, the selected value is displayed as a combined text of both FirstName and City in the DropDownList input, which is separated by a hyphen.
{% if page.publishingplatform == "typescript" %}
{% tabs %} {% highlight ts tabtitle="index.ts" %} {% include code-snippet/dropdownlist/item-template-cs2/index.ts %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/item-template-cs2/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/item-template-cs2" %}
{% elsif page.publishingplatform == "javascript" %}
{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/dropdownlist/item-template-cs2/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/item-template-cs2/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/item-template-cs2" %} {% endif %}
The group header title under which appropriate sub-items are categorized can also be customize with the help of groupTemplate property. This template is common for both inline and floating group header template.
In the following sample, employees are grouped according to their city.
{% if page.publishingplatform == "typescript" %}
{% tabs %} {% highlight ts tabtitle="index.ts" %} {% include code-snippet/dropdownlist/item-template-cs3/index.ts %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/item-template-cs3/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/item-template-cs3" %}
{% elsif page.publishingplatform == "javascript" %}
{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/dropdownlist/item-template-cs3/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/item-template-cs3/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/item-template-cs3" %} {% endif %}
The header element is shown statically at the top of the popup list items within the DropDownList, and any custom element can be placed as a header element using the headerTemplate property.
In the following sample, the list items and its headers are designed and displayed as two columns similar to multiple columns of the grid.
{% if page.publishingplatform == "typescript" %}
{% tabs %} {% highlight ts tabtitle="index.ts" %} {% include code-snippet/dropdownlist/header-template-cs1/index.ts %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/header-template-cs1/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/header-template-cs1" %}
{% elsif page.publishingplatform == "javascript" %}
{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/dropdownlist/header-template-cs1/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/header-template-cs1/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/header-template-cs1" %} {% endif %}
The DropDownList has options to show a footer element at the bottom of the list items in the popup list. Here, you can place any custom element as a footer element using the footerTemplate property.
In the following sample, footer element displays the total number of list items present in the DropDownList.
{% if page.publishingplatform == "typescript" %}
{% tabs %} {% highlight ts tabtitle="index.ts" %} {% include code-snippet/dropdownlist/footer-template-cs1/index.ts %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/footer-template-cs1/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/footer-template-cs1" %}
{% elsif page.publishingplatform == "javascript" %}
{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/dropdownlist/footer-template-cs1/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/footer-template-cs1/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/footer-template-cs1" %} {% endif %}
The DropDownList is provided with support to custom design the popup list content when no data is found and no matches found on search with the help of noRecordsTemplate property.
In the following sample, popup list content displays the notification of no data available.
{% if page.publishingplatform == "typescript" %}
{% tabs %} {% highlight ts tabtitle="index.ts" %} {% include code-snippet/dropdownlist/norecords-template-cs1/index.ts %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/norecords-template-cs1/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/norecords-template-cs1" %}
{% elsif page.publishingplatform == "javascript" %}
{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/dropdownlist/norecords-template-cs1/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/norecords-template-cs1/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/norecords-template-cs1" %} {% endif %}
There is also an option to custom design the popup list content when the data fetch request fails at the remote server. This can be achieved using the actionFailureTemplate property.
In the following sample, when the data fetch request fails, the DropDownList displays the notification.
{% if page.publishingplatform == "typescript" %}
{% tabs %} {% highlight ts tabtitle="index.ts" %} {% include code-snippet/dropdownlist/norecords-template-cs2/index.ts %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/norecords-template-cs2/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/norecords-template-cs2" %}
{% elsif page.publishingplatform == "javascript" %}
{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/dropdownlist/norecords-template-cs2/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/dropdownlist/norecords-template-cs2/index.html %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/dropdownlist/norecords-template-cs2" %} {% endif %}