Skip to content

Commit 78dc4b7

Browse files
docs(common): add project config to what you need, move it under getting started
1 parent 92a62be commit 78dc4b7

File tree

7 files changed

+51
-17
lines changed

7 files changed

+51
-17
lines changed

_contentTemplates/common/issues-and-warnings.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,14 @@
22
>warning [.NET Core Issue 8385](https://github.com/aspnet/AspNetCore/issues/8385) is preventing the ValueChanged handler from working at the moment. The code below will work as soon as Microsoft release a fix for this problem. Until then, you may get compilation issue due to the handler presence. We strive to follow best practices and future-proof our components, which is why we are using this approach even though it does not work yet.
33
#end
44

5+
6+
#mono-linker-issue
7+
Open the Client `.csproj` file and ensure that the following switch is present. At the moment the IL Linker needs to be disabled because of [an issue in Mono](https://github.com/mono/mono/issues/12917).
8+
9+
**.csproj**
10+
11+
<PropertyGroup>
12+
<!-- there may be other elements here -->
13+
<BlazorLinkOnBuild>false</BlazorLinkOnBuild>
14+
</PropertyGroup>
15+
#end

getting-started/client-blazor.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,7 @@ For client-side Blazor, we recommend the usage of `Blazor (ASP.NET Hosted)` proj
7373
}
7474
}
7575

76-
1. Open the Client `.csproj` file and ensure that the following switch is present. At the moment the IL Linker needs to be disabled because of [an issue in Mono](https://github.com/mono/mono/issues/12917).
77-
78-
**.csproj**
79-
80-
<PropertyGroup>
81-
<!-- there may be other elements here -->
82-
<BlazorLinkOnBuild>false</BlazorLinkOnBuild>
83-
</PropertyGroup>
76+
1. @[template](/_contentTemplates/common/issues-and-warnings.md#mono-linker-issue)
8477

8578

8679

getting-started/server-blazor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: First Steps with UI for Blazor Server-side
55
slug: getting-started/server-side
66
tags: get,started,first,steps,server
77
published: true
8-
position: 1
8+
position: 2
99
---
1010

1111
# First Steps with Server-side UI for Blazor

installation/what-you-need.md renamed to getting-started/what-you-need.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,23 @@
22
title: What You Need
33
page_title: What You Need
44
description: What you need to use the Telerik Blazor components.
5-
slug: installation/what-you-need
5+
slug: getting-started/what-you-need
6+
previous_url: installation//what-you-need
67
tags: get,started,installation,what,need,list
78
published: True
8-
position: 0
9+
position: 3
910
---
1011

1112
# What You Need to Use the Telerik Blazor Components
1213

1314
This article explains the packages you need to use the Telerik UI for Blazor components, and how to get them.
1415

16+
To use the Telerik UI for Blazor, you need:
17+
18+
1. To get the [Telerik Blazor packages](#telerk-specific-packages) in your project
19+
1. Add the [client assets](#client-assets)
20+
1. [Set up the project](#project-configuration) to regognize the Telerik components
21+
1522
## Telerik Specific Packages
1623

1724
The Telerik UI for Blazor component suite requires the following two Telerik-specific NuGet packages:
@@ -51,6 +58,29 @@ To have the Telerik Blazor components look and behave as expected in the browser
5158

5259
For a server-side Blazor scenario, add it to the `~/Pages/_Host.razor` file.
5360

61+
## Project Configuration
62+
63+
To have the framework recognize the Telerik Components, you must register them in the `Startup.cs` file of your Blazor project (if you are using [client-side Blazor](), this is the client web application's file):
64+
65+
````Startup.cs
66+
namespace MyBlazorAppName
67+
{
68+
public class Startup
69+
{
70+
public void ConfigureServices(IServiceCollection services)
71+
{
72+
//more code may be present here
73+
services.AddTelerikBlazor();
74+
}
75+
76+
//more code may be present here
77+
}
78+
}
79+
````
80+
81+
If you are using a client-side Blazor project,
82+
@[template](/_contentTemplates/common/issues-and-warnings.md#mono-linker-issue)
83+
5484
## Before You Continue
5585

5686
Before you continue, make sure you can use Blazor. Read below for more details.

installation/msi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ While the most common way to install the Telerik UI for Blazor components is to
1616

1717
The `MSI` installer provides the following:
1818

19-
* The [necessary `.nupkg` files]({%slug installation/what-you-need%}) so you can setup a [local feed in Visual Studio](#set-up-a-local-nuget-feed-in-visual-studio). You can find them in the `packages` folder under the installation folder.
19+
* The [necessary `.nupkg` files]({%slug getting-started/what-you-need%}) so you can setup a [local feed in Visual Studio](#set-up-a-local-nuget-feed-in-visual-studio). You can find them in the `packages` folder under the installation folder.
2020
* A shortcut to our [online demos](https://demos.telerik.com/blazor-ui).
2121

2222

@@ -40,7 +40,7 @@ Once the download completes, run the MSI file and follow the instructions. The d
4040

4141
## See Also
4242

43-
* [What You Need To Install]({%slug installation/what-you-need%})
43+
* [What You Need To Install]({%slug getting-started/what-you-need%})
4444
* [Get Started with Client-side Blazor]({%slug getting-started/client-side%})
4545
* [Get Started with Server-side Blazor]({%slug getting-started/server-side%})
4646

installation/nuget.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ position: 1
1212

1313
This article explains how to add the private Telerik NuGet feed to your system. You can use it to obtain the Telerik UI for Blazor components.
1414

15-
>tip Once you have the feed working, you can add the Telerik components to your project - both [client-side Blazor](../getting-started/client-blazor) and [server-side Blazor](../getting-started/server-blazor). You can also find more details in the [What You Need](what-you-need) article.
15+
>tip Once you have the feed working, you can add the Telerik components to your project - both [client-side Blazor](../getting-started/client-blazor) and [server-side Blazor](../getting-started/server-blazor). You can also find more details in the [What You Need](../getting-started/what-you-need) article.
1616
1717
## Add the Telerik Private NuGet Feed to Your System
1818

@@ -64,7 +64,7 @@ NuGet Sources Update -Name "telerik.com" -Source "https://nuget.telerik.com/nuge
6464

6565
## See Also
6666

67-
* [What You Need To Install]({%slug installation/what-you-need%})
67+
* [What You Need To Install]({%slug getting-started/what-you-need%})
6868
* [Get Started with Client-side Blazor]({%slug getting-started/client-side%})
6969
* [Get Started with Server-side Blazor]({%slug getting-started/server-side%})
7070

installation/zip.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ While the most common way to install the Telerik UI for Blazor components is to
1616

1717
The `ZIP` archive provides the following:
1818

19-
* The [necessary `.nupkg` files]({%slug installation/what-you-need%}) so you can setup a [local feed in Visual Studio](#set-up-a-local-nuget-feed-in-visual-studio). You can find them in the `packages` folder in the archive.
19+
* The [necessary `.nupkg` files]({%slug getting-started/what-you-need%}) so you can setup a [local feed in Visual Studio](#set-up-a-local-nuget-feed-in-visual-studio). You can find them in the `packages` folder in the archive.
2020
* An offline version of our [demos](https://demos.telerik.com/blazor-ui) that you can run and inspect in your IDE. You can find them in the `demos` folder in the archive.
2121

2222

@@ -39,7 +39,7 @@ Once the download completes, open the archive and extract the files to a locatio
3939

4040
## See Also
4141

42-
* [What You Need To Install]({%slug installation/what-you-need%})
42+
* [What You Need To Install]({%slug getting-started/what-you-need%})
4343
* [Get Started with Client-side Blazor]({%slug getting-started/client-side%})
4444
* [Get Started with Server-side Blazor]({%slug getting-started/server-side%})
4545

0 commit comments

Comments
 (0)