Skip to content

Merge icons-using-1288 into production #1289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dimodi merged 1 commit into from
Jan 18, 2023
Merged

Merge icons-using-1288 into production #1289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions common-features/icons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,23 @@ This article contains the following sections:

## How Icons Work

The Telerik Blazor components use built-in icons with the help of two NuGet packages. These are installed automatically as dependencies of the `Telerik.UI.for.Blazor` package. No manual actions are necessary. These icon packages are:
The Telerik Blazor components use built-in icons with the help of two NuGet packages. They are installed *automatically* as dependencies of the `Telerik.UI.for.Blazor` package:

* `Telerik.FontIcons` - defines the `FontIcon` `enum` for easier usage of built-in font icons
* `Telerik.SvgIcons` - defines the `ISvgIcon` interface and the `SvgIcon` static class for built-in SVG icons
* `Telerik.FontIcons` - defines the `FontIcon` `enum` for easier usage of built-in **font** icons
* `Telerik.SvgIcons` - defines the `ISvgIcon` interface and the `SvgIcon` static class for built-in **SVG** icons

Some components provide icon-related parameters, which can rely on the above packages too. For example:
To use the icons, import one or both namespaces, for example in `_Imports.razor`:

>caption Register Telerik Blazor icon namespaces

<div class="skip-repl"></div>

````CSHTML
@using Telerik.FontIcons
@using Telerik.SvgIcons
````

Some components provide icon-related parameters, which can rely on the above packages and namespaces too. For example:

>caption Icon parameter in Telerik Blazor components

Expand Down
4 changes: 3 additions & 1 deletion getting-started/client-blazor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,14 @@ To enable the Telerik UI for Blazor components, you must add several client-side
**C#**
@[template](/_contentTemplates/common/js-interop-file.md#register-telerik-service-client)

5\. In the `~/_Imports.razor` file, add the `@using` directives below&mdash;this configures the project to recognize the Telerik components in all files.
5\. In the `~/_Imports.razor` file, add the `@using` directives below. This configures the project to recognize the Telerik components in all files. You can register one or both icon namespaces, depending on the [icon type you will be using]({%slug general-information/font-icons%}).

**_Imports.razor**

@using Telerik.Blazor
@using Telerik.Blazor.Components
@using Telerik.FontIcons
@using Telerik.SvgIcons


6\. @[template](/_contentTemplates/common/get-started.md#root-component-telerik-layout)
Expand Down
7 changes: 4 additions & 3 deletions getting-started/server-blazor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,19 +74,20 @@ To enable the Telerik UI for Blazor components, you must add several client-side
**C#**
@[template](/_contentTemplates/common/js-interop-file.md#register-telerik-service-server)

5\. In the `~/_Imports.razor` file, add the `@using` directives below&mdash;this configures the project to recognize the Telerik components in all files.
5\. In the `~/_Imports.razor` file, add the `@using` directives below. This configures the project to recognize the Telerik components in all files. You can register one or both icon namespaces, depending on the [icon type you will be using]({%slug general-information/font-icons%}).

**_Imports.razor**

@using Telerik.Blazor
@using Telerik.Blazor.Components
@using Telerik.FontIcons
@using Telerik.SvgIcons


7\. @[template](/_contentTemplates/common/get-started.md#root-component-telerik-layout)

8\. @[template](/_contentTemplates/common/get-started.md#root-component-main-layout)



Now your Blazor Server project can use the Telerik UI for Blazor components.

## Step 5: Add a Component to a View
Expand Down
8 changes: 7 additions & 1 deletion getting-started/what-you-need.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,17 @@ To use the Telerik components, you must add a few items to your projects. Some o

### Common Configuration

You can set the project to recognize all Telerik components without explicit `@using` statements on every `.razor` file. To achieve this, add the following to your `~/_Imports.razor` file:
You can set the project to recognize all Telerik components without explicit `@using` statements on every `.razor` file. To achieve this, add the following to your `~/_Imports.razor` file. You can register one or both icon namespaces, depending on the [icon type you will be using]({%slug general-information/font-icons%}).

>caption _Imports.razor
<div class="skip-repl"></div>

````CSHTML
@using Telerik.Blazor
@using Telerik.Blazor.Components
@using Telerik.FontIcons
@using Telerik.SvgIcons
````

To enable the use of detached popups (for example, dropdown lists, menus, grid filters, etc.), you must add a `TelerikLayout.razor` component at the root level of the DOM:
Expand Down
12 changes: 10 additions & 2 deletions hybrid-blazor-apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,17 @@ You may add the Telerik resources as [static assets]({%slug getting-started/what

### 3. Include `@using` statements

You can set the project to recognize all Telerik components without explicit `@using `statements on every `.razor` file. To achieve this, add the following to your `~/_Imports.razor`file:
You can set the project to recognize all Telerik components without explicit `@using `statements on every `.razor` file. To achieve this, add the following to your `~/_Imports.razor`file. You can register one or both icon namespaces, depending on the [icon type you will be using]({%slug general-information/font-icons%}).

````
>caption _Imports.razor

<div class="skip-repl"></div>

````CSHTML
@using Telerik.Blazor
@using Telerik.Blazor.Components
@using Telerik.FontIcons
@using Telerik.SvgIcons
````

### 4. Add the `TelerikRootComponent`
Expand All @@ -76,6 +82,8 @@ The final step is to register the Telerik services. Add the Telerik services in

For example, in MAUI app, you register services in the `MauiProgram.cs`:

<div class="skip-repl"></div>

````CSHTML
namespace MyBlazorMauiAppName
{
Expand Down