New to Kendo UI for jQuery? Download free 30-day trial

Appearance

As of Kendo UI R1 2022, the jQuery ComboBox widget has new rendering and styling options.

In this article, you will find information about the rendering of the Kendo UI ComboBox.

For additional information regarding the decision behind these changes, visit the Styling Components article.

For a live example, visit the Appearance Demo of the ComboBox.

Options

The Kendo UI ComboBox supports the following styling options:

  • size—configures the overall size of the component.
  • rounded—configures the border radius for the tags.
  • fillMode—controls how the color is applied.

Size

The size option controls how big or small the ComboBox component looks. The structure of the class is k-input-{size}.

The following values are available for the size option:

  • sm—small size
  • md—medium size
  • lg—large size

The default size value is medium and it is applied to the span wrapping element through the k-input-md class.

The example below shows a basic configuration and how to set size to "large":

<input id="combobox" />
<script>
    $("#combobox").kendoComboBox({
      size: "large"
    });
</script>

Below is the HTML that is affected from the configuration. The changes are applied to the span.k-combobox wrapping element:

<span class="k-combobox k-input k-input-lg">
    ...
</span>

Rounded

The rounded option controls how much border radius is applied to the tags for the selected items in the widget. The structure of the class is k-rounded-{size}.

The following values are available for the rounded option:

  • sm—small border radius
  • md—medium border radius
  • lg—large border radius
  • full—ellipse-like border radius

The default value is medium and it is applied to the span.k-combobox wrapping element through the k-rounded-md class.

The example below shows a basic ComboBox configuration and how to set rounded to "full":

<input id="combobox" />
<script>
    $("#combobox").kendoComboBox({
      rounded: "full"
    });
</script>

The changes are applied to the span.k-combobox wrapping element:

<span class="k-combobox k-input k-rounded-full">
    ...
</span>

FillMode

The fillMode option controls how the color is applied. The structure of the class is k-input-{fillMode}.

The following values are available for the fillMode option:

  • solid
  • flat
  • outline

The default value is solid and it is applied to the span.k-combobox wrapping element through the k-input-solid class.

The example below shows a basic ComboBox configuration and how to set fillMode to "outline":

<input id="combobox" />
<script>
    $("#combobox").kendoComboBox({
      fillMode: "outline"
    });
</script>

The changes are applied to the span.k-combobox wrapping element:

<span class="k-combobox k-input k-input-outline">
    ...
</span>

Old vs New Rendering

The old rendering of the component consisted of several wrapping elements:

  • The outer span wrapper with the k-combobox and k-widget classes.

    <span class="k-widget k-combobox">
    </span>
    
  • The inner span wrapper with the k-dropdown-wrap class.

    <span class="k-dropdown-wrap k-state-default">
    </span>
    
  • The input element with the k-input class. This element is a child of the k-dropdown-wrap span.

    <input class="k-input" role="combobox" >
    </span>
    
  • The button span element with k-select class. This element is a child of the k-dropdown-wrap span and renders the button which expands the dropdown on click.

    <span unselectable="on" class="k-select" role="button">
    </span>
    
  • The icon span element with the k-icon class. This element is a child of the k-select span and renders the dropdown arrow icon.

    <span class="k-icon k-i-arrow-60-down">
    

The new rendering of the component consists of a wrapping span element that contains the child input and button elements:

  • The span element controls the overall appearance of the widget and has the following class structure:

    <span class="k-input k-combobox k-widget k-input-solid k-input-md k-rounded-md">
    </span>
    
  • The input element controls the appearance of the Combobox itself and has the following class structure:

    <input type="text" class="k-input-inner" value="..." placeholder="..." />
    
  • The button element controls the appearance of the button that expands the dropdown popup and has the following class structure:

    <button type="button" class="k-select k-input-button k-button k-icon-button k-button-md k-button-solid k-button-solid-base k-icon-button">
    </button>
    
  • The inner span element renders the dropdown arrow icon of the ComboBox and has the following class structure:

    <span class="k-icon k-i-arrow-s k-button-icon"></span>
    

Below you will find the differences between the old and the new rendering.

Wrapper Rendering:

<!-- OLD WRAPPER-->
<span class="k-widget k-combobox">
    <input id="combobox" type="text" class="k-input" placeholder="...">
</span>

<!-- NEW WRAPPER -->
<span class="k-combobox k-input k-input-md k-rounded-md k-input-solid">
    <input type="text" class="k-input-inner" value="..." placeholder="..." />
</span>

Popup rendering without virtualization:

<!-- OLD POPUP WITHOUT VIRTUALIZATION-->
<div class="k-list-container k-popup k-group k-reset k-state-border-up" id="products-list" data-role="popup">
    [Header template]
    <div class="k-group-header">Argentina</div>
    <div class="k-list-scroller">
      <ul class="k-list k-reset">
        <li class="k-item">Patricio Simpson</li>
        ...
        <li class="k-item k-first">
            Ann Devon
            <div class="k-group">UK</div>
        </li>
        ...
      </ul>
    </div>
    <div class="k-nodata">
      <div>No Data!</div>
    </div>
    <div class="k-footer">
      [Footer template]
    </div>
</div>

<!-- NEW POPUP WITHOUT VIRTUALIZATION -->
<div class="k-popup k-group k-reset">
    <div class="k-list k-list-md">
        <div class="k-list-header">
            [header template]
        </div>
        <div class="k-list-group-sticky-header">Argentina</div>
        <div class="k-list-content k-list-scroller">
            <ul class="k-list-ul">
                <li class="k-list-item">
                    <span class="k-list-item-text">Patricio Simpson</span>
                </li>
                ...
                <li class="k-list-item k-first">
                    <span class="k-list-item-text">Roland Mendel</span>
                    <div class="k-list-item-group-label">Austria</div>
                </li>
                ...
            </ul>
        </div>
        <div class="k-nodata">
            <div>No data found.</div>
        </div>
        <div class="k-list-footer">
            [Footer template]
        </div>
    </div>
</div>

Popup rendering with virtualization:

<!-- OLD POPUP WITH VIRTUALIZATION-->
<div class="k-list-container k-popup k-group k-reset">
    <div>
       [Header template]
    </div>
    <div class="k-virtual-wrap">
        <div class="k-group-header"></div>
        <div class="k-virtual-content">
          <ul class="k-list k-reset k-virtual-list">
            <li class="k-virtual-item k-item">
              Vins et alcools Chevalier
            </li>
            ...
            <li class="k-virtual-item k-item">
              Toms Spezialitäten
            </li>
            ...
          </ul>
          <div class="k-height-container">
            <div style="height: ....;"></div>
          </div>
        </div>
    </div>
    <div class="k-nodata">
        <div>No data found.</div>
    </div>
    <div class="k-footer">
        [Footer template]
    </div>
</div>

<!-- NEW POPUP WITH VIRTUALIZATION-->
<div class="k-popup k-group k-reset">
    <div class="k-list k-list-md k-virtual-list">
        <div class="k-list-header">
            [Header template]
        </div>
        <div class="k-list-group-sticky-header">Argentina</div>
        <div class="k-list-content k-virtual-content">
            <ul class="k-list-ul">
                <li class="k-list-item">
                    <span class="k-list-item-text">
                        Text
                    </span>
                </li>
                ...
                <li class="k-list-item k-first">
                    <span class="k-list-item-text">
                        Ernst Handel, Austria
                    </span>
                    <div class="k-list-item-group-label">Austria</div>
                </li>
                ...
            </ul>
            <div class="k-height-container">
                <div style="height: ...;"></div>
            </div>
        </div>
        <div class="k-nodata">
            <div>No data found.</div>
        </div>
        <div class="k-list-footer">
            [Footer template]
        </div>
    </div>
</div>

Visual Backwards Compatibility

In order to achieve the same look and feel as the old rendering, the element references must be updated. Visit the CSS Classes Migration and JQuery Selectors Migration sections of the Styling Overview article for additional information.

The new styling and rendering supports only the default options when you use a LESS theme.

Previously, a reference to the ComboBox input element was obtainable through the k-input class.

$(".k-input") // Returns a reference to the input element in the old rendering.

With the new rendering, the ComboBox input element must be targeted by using the k-input-inner class.

$(".k-input-inner") // Returns a reference to the input element in the new rendering.

Setting the List Width

To customize the width of the ComboBox list and change its dimensions, use the jQuery width() method.

<input id="comboBox" />

<script>
    var combobox = $("#combobox").data("kendoComboBox");
    // Set the width of the drop-down list.
    combobox.list.width(400);
</script>

Setting the Popup Width

You can enable the popup element to automatically adjust its width according to the length of the item label it displays. When the autoWidth option is set to true, the popup will display the content on a single line and will not wrap it up.

Virtualized lists do not support the auto-width functionality.

<input id="combobox" style="width: 100px;" />
<script>
$("#combobox").kendoComboBox({
  autoWidth: true,
  dataSource: {
    data: ["Short item", "An item with really, really long text"]
  }
});
</script>

Accessing list Elements

The ComboBox list renders an ID attribute which is generated from the ID of the widget and the -list suffix. You can use the ID to style the element or to access a specific element inside the popup element.

If the ComboBox has no ID, the list element will have no ID either.

<input id="combobox">
<script>
  $(document).ready(function() {
    $("#combobox").kendoComboBox({
        dataSource: ["Item1", "Item2"]
    });

    // The DIV popup element that holds header and footer templates and the suggestion options.
    var popupElement = $("#combobox-list");

    console.log(popupElement);
  });
</script>

Supporting label Elements

Because of its complex rendering, the focusing of the widget by using a label element requires additional implementation. For a runnable example, refer to this Kendo UI Dojo demo.

Removing Input Values

The ComboBox enables you to remove the values from its input area by using the clearButton configuration option. As a result, an X button appears in the input area on hover and when clicked, it resets the value of the widget and triggers the change event. By default, clearButton is enabled and is set to true.

See Also

In this article