Icons
The DropDownButton provides options for visually enhancing its textual content by adding icons to it.
You can add an icon with the img
element or with a background image (usually a sprite). With regard to web standards, using background images is better because the icon represents a decoration, not structural content.
The DropDownButton provides the icon
, spriteCssClass
, and imageUrl
properties for configuring icons. With a specific DropDownButton instance, you have to use only one of them—if you define multiple properties, the DropDownButton will work with only one of them in the order previously stated.
For a complete example on rendering an Icon DropDownButton, refer to the Icons demo of the DropDownButton.
To visually enhance the DropDownButton, use any of the following approaches:
Background Icons
Background icons are applied through the icon
or spriteCssClass
properties and are displayed as a background of a span
element. The DropDownButton can either:
- Automatically render the
span
element. - Use an existing
span
element—Possible only if the element has ak-sprite
CSS class or ak-icon
CSS class (if you use theicon
property). The difference between theicon
andspriteCssClass
properties is thaticon
is intended for use with the built-in Kendo UI icons which are part of the theme sprite. For a list of the available icon names, refer to the demo on using icons.
The following example demonstrates how to use icons in the DropDownButton component:
<button type="button" id="dropDownButton">Plus</button>
<script>
$(function(){
$("#dropDownButton").kendoDropDownButton({
icon: "plus"
});
});
</script>
The icon
configuration in the previous example will produce the following HTML output:
```html
<button type="button" id="dropDownButton" data-role="dropdownbutton" class="k-menu-button k-button k-button-md k-rounded-md k-button-solid k-button-solid-base" aria-label="Plus dropdownbutton">
<span class="k-icon k-i-plus k-button-icon"></span>
<span class="k-button-text">Plus</span>
</button>
```
The following example demonstrates how to apply the spriteCssClass
:
```
<button type="button" id="dropDownButton">Plus</button>
<script>
$(function(){
$("#dropDownButton").kendoDropDownButton({
spriteCssClass: "myPlusIcon"
});
});
</script>
```
Technically, you can use the spriteCssClass
to achieve the same result as icon
. However, icon
avoids the need to set two CSS classes at the same time and provides a certain level of abstraction.
Image Icons
Image icons are applied over the imageUrl
property and are displayed as an img
element. You can use imageUrl
to set an image for the default button, and the items.imageUrl
to set the image for each item in the dropdown.
Font Icons
You can also use FontAwesome or other font icons inside the Kendo UI DropDownButton by setting the required third-party CSS classes over the spriteCssClass
property. However, this approach will render a k-sprite
CSS class which applies font and size styles that may interfere with the font icon styles.
To handle this issue, use either of the following approaches:
-
Override the Kendo UI styles which break the font icons.
<link href="https://netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet" /> <style> .k-button .fa { font-size: inherit; line-height: inherit; width: auto; height: auto; margin-left: 0; } </style> <button type="button" id="archiveButton">Archive</button> <script> $("#archiveButton").kendoDropDownButton({ spriteCssClass: "fa fa-archive", items:[ { text: "Item 1"}, { text: "Item 2"}, ] }); </script>
-
Include the required HTML markup and CSS classes inside the Kendo UI DropDownButton directly as template content. In this way, the DropDownButton will not render a
k-sprite
class.<link href="https://netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet" /> <button type="button" id="archiveButton"><span class="fa fa-archive"></span> Archive</button> <script> $("#archiveButton").kendoDropDownButton({ items:[ { text: "Item 1"}, { text: "Item 2"}, ] }); </script>