Built-in Icons

The UI for Blazor suite comes with a set of font icons that you can use in various places like in the Button component, or as a standalone component.

In this article:

Standalone Icon Component

Telerik UI for Blazor provides a component that you can use to render icons - the TelerikIcon component. It works with the following types of images (examples of their usage follow):

  • Telerik font icon - the Icon parameter takes a Telerik icon from the set we provide out-of-the-box through the Telerik.Blazor.IconName static class.

    • The Visual Studio intellisense should provide you with the available options and you can also see them in the online API Reference.

    • You can find the full list of available icons in the Kendo UI Web Font Icons Library article. The names of the icons match the classes you see in the article, but without the k-i- prefix. You can use them as hardcoded strings as well. Their corresponding class members are in CamelCase.

  • Third party font-icon - the IconClass parameter lets you set a CSS class that provides the required font name, font size and content for the ::before pseudoelement.

  • Raster image - the ImageUrl is a string points to the image - it can be a path relative to the wwwroot folder, or an absolute URL.

  • Raster image sprite - the SpriteClass parameter lets you provide the classes from your site's stylesheet that produce the desired appearance and background positions for your sprites.

Render a standalone icon through the TelerikIcon component

<TelerikIcon Icon="@IconName.Audio" /> @* will render the audio note icon *@

@* <TelerikIcon Icon="audio" /> *@ @* This would also render the same audio icon *@

<TelerikIcon IconClass="oi oi-home" /> @* home icon from OpenIconic, assuming you have loaded the font on the page, you can use your own CSS classes and font icon fonts *@

<TelerikIcon ImageUrl="https://docs.telerik.com/blazor-ui/images/snowboarding.png" /> @* an image by URL, renders an actual <img /> tag *@

The result from the snippet above

Icon Parameters - Order of Precedence

The priority order of the Icon properties, if more than one is defined, is

  1. ImageUrl
  2. Icon
  3. IconClass
  4. SpriteClass

This order applies to other components that expose the same parameters, such as the TelerikButton or the grid command buttons.

Icon in Telerik Component

Some Telerik components expose icon features out-of-the box. These parameters match the TelerikIcon component described above.

How to use a built-in font icon class on a component's Icon property

<TelerikButton Icon="@IconName.Filter">I show the Filter icon</TelerikButton>
<br />
<TelerikButton Icon="filter">I also show the Filter icon through a hardcoded class name</TelerikButton>

The result from the code snippet above

See Also

In this article
Not finding the help you need? Improve this article