Skip to content

Commit b665c96

Browse files
gvreddy04gvreddy04
authored
Getting started docs update (#7)
* Getting started docs updated
1 parent 79e4a55 commit b665c96

14 files changed

Lines changed: 92 additions & 8 deletions

‎BlazorExpress.ChartJS.Demo.RCL/Components/Layout/MainLayout.razor.cs‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ internal override IEnumerable<NavItem> GetNavItems()
77
navItems ??= new List<NavItem>
88
{
99
new (){ Id = "1", Text = "Overview", Href = "/charts/overview", IconName = IconName.HouseDoorFill },
10-
new (){ Id = "2", Text = "Getting Started", Href = "/charts/getting-started", IconName = IconName.Palette2 },
10+
11+
new (){ Id = "2", Text = "Getting Started", IconName = IconName.Palette2 },
12+
new (){ Id = "201", Text = "Blazor WebAssembly (.NET 8)", Href = "/charts/getting-started/blazor-webassembly-net-8", IconName = IconName.Palette2, ParentId = "2", Match = NavLinkMatch.All },
13+
new (){ Id = "202", Text = "Blazor WebApp Server (.NET 8)", Href = "/charts/getting-started/blazor-webapp-server-global-net-8", IconName = IconName.Palette2, ParentId = "2", Match = NavLinkMatch.All },
14+
new (){ Id = "202", Text = "Blazor WebApp Auto (.NET 8)", Href = "/charts/getting-started/blazor-webapp-auto-global-net-8", IconName = IconName.Palette2, ParentId = "2", Match = NavLinkMatch.All },
1115

1216
new (){ Id = "3", Text = "Bar Chart", IconName = IconName.BarChartLineFill },
1317
new (){ Id = "301", Text = "Bar", Href = "/charts/bar-chart", IconName = IconName.BarChartLine, ParentId = "3", Match = NavLinkMatch.All },
@@ -30,7 +34,6 @@ internal override IEnumerable<NavItem> GetNavItems()
3034
new (){ Id = "600", Text = "Pie", Href = "/charts/pie-chart", IconName = IconName.PieChart, ParentId = "6", Match = NavLinkMatch.All },
3135
new (){ Id = "600", Text = "Data labels", Href = "/charts/pie-chart/data-labels", IconName = IconName.PieChart, ParentId = "6", Match = NavLinkMatch.All },
3236
new (){ Id = "600", Text = "Legend position", Href = "/charts/pie-chart/legend", IconName = IconName.PieChart, ParentId = "6", Match = NavLinkMatch.All },
33-
3437
};
3538

3639
return navItems;

BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/GettingStarted.razor renamed to BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_01_WebAssembly/GettingStarted.razor

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@
1111
<div class="mb-3">
1212
Looking to quickly add <b>BlazorExpress.ChartJS</b> to your project? Use NuGet package manager.
1313
</div>
14-
<Snippet LanguageCode="LanguageCode.PowerShell" FilePath="~\Components\Pages\GettingStarted\Getting_Started_Snippet_01_Install.txt" />
14+
<Snippet LanguageCode="LanguageCode.PowerShell" FilePath="~\Components\Pages\GettingStarted\NET8_01_WebAssembly\Getting_Started_Snippet_01_Install.txt" />
1515

1616
<SectionHeading Size="HeadingSize.H4" Text="Add script references" PageUrl="@pageUrl" HashTagName="add-script-references" />
1717
<div class="mb-3">
1818
Insert the following references into the <b>body</b> section of the <b>wwwroot/index.html</b> file, immediately after the <b>_framework/blazor.webassembly.js</b> reference:
1919
</div>
20-
<Snippet LanguageCode="LanguageCode.JavaScript" FilePath="~\Components\Pages\GettingStarted\Getting_Started_Snippet_02_Scripts.html" />
20+
<Snippet LanguageCode="LanguageCode.JavaScript" FilePath="~\Components\Pages\GettingStarted\NET8_01_WebAssembly\Getting_Started_Snippet_02_Scripts.html" />
2121

2222
<SectionHeading Size="HeadingSize.H4" Text="Register services" PageUrl="@pageUrl" HashTagName="register-services" />
2323
<div class="mb-3">
2424
Register tag helpers in <b>_Imports.razor</b>.
2525
</div>
26-
<Snippet LanguageCode="LanguageCode.Razor" FilePath="~\Components\Pages\GettingStarted\Getting_Started_Snippet_03_Register.txt" />
26+
<Snippet LanguageCode="LanguageCode.Razor" FilePath="~\Components\Pages\GettingStarted\NET8_01_WebAssembly\Getting_Started_Snippet_03_Register.txt" />
2727

2828
@code {
2929
private const string pageUrl = "/charts/getting-started";

BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/Getting_Started_Snippet_01_Install.txt renamed to BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_01_WebAssembly/Getting_Started_Snippet_01_Install.txt

File renamed without changes.

BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/Getting_Started_Snippet_02_Scripts.html renamed to BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_01_WebAssembly/Getting_Started_Snippet_02_Scripts.html

File renamed without changes.

BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/Getting_Started_Snippet_03_Register.txt renamed to BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_01_WebAssembly/Getting_Started_Snippet_03_Register.txt

File renamed without changes.

‎BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_02_WebApp_Server_Global/GettingStarted.razor‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
@attribute [Route(pageUrl)]
2+
3+
<PageHeroSection PageUrl="@pageUrl"
4+
Title="@title"
5+
Heading="@heading"
6+
Description="@description"
7+
ImageUrl="@imageUrl" />
8+
9+
<SectionHeading Size="HeadingSize.H4" Text="Install Nuget Package" PageUrl="@pageUrl" HashTagName="install-nuget-package" />
10+
<div class="mb-3">
11+
Looking to quickly add <b>BlazorExpress.ChartJS</b> to your project? Use NuGet package manager.
12+
</div>
13+
<Snippet LanguageCode="LanguageCode.PowerShell" FilePath="~\Components\Pages\GettingStarted\NET8_02_WebApp_Server_Global\Getting_Started_Snippet_01_Install.txt" />
14+
15+
<SectionHeading Size="HeadingSize.H4" Text="Add script references" PageUrl="@pageUrl" HashTagName="add-script-references" />
16+
<div class="mb-3">
17+
Insert the following references into the <b>body</b> section of the <b>Components/App.razor</b> file, immediately after the <b>_framework/blazor.web.js</b> reference:
18+
</div>
19+
<Snippet LanguageCode="LanguageCode.JavaScript" FilePath="~\Components\Pages\GettingStarted\NET8_02_WebApp_Server_Global\Getting_Started_Snippet_02_Scripts.html" />
20+
21+
<SectionHeading Size="HeadingSize.H4" Text="Register services" PageUrl="@pageUrl" HashTagName="register-services" />
22+
<div class="mb-3">
23+
Register tag helpers in <b>Components/_Imports.razor</b>.
24+
</div>
25+
<Snippet LanguageCode="LanguageCode.Razor" FilePath="~\Components\Pages\GettingStarted\NET8_02_WebApp_Server_Global\Getting_Started_Snippet_03_Register.txt" />
26+
27+
@code {
28+
private const string pageUrl = "/charts/getting-started/blazor-webapp-server-global-net-8";
29+
private const string title = "Getting started - Blazor WebApp (.NET 8) - Interactive render mode Server - Global location";
30+
private const string heading = "Getting started - Blazor WebApp (.NET 8) - Interactive render mode Server - Global location";
31+
private const string description = "Get started with the Enterprise-class Component library built on the Blazor and Chart.js JavaScript library.";
32+
private const string imageUrl = "https://i.imgur.com/C5ObC3A.png";
33+
}

‎BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_02_WebApp_Server_Global/Getting_Started_Snippet_01_Install.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Install-Package BlazorExpress.ChartJS -Version 1.0.0-preview1

‎BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_02_WebApp_Server_Global/Getting_Started_Snippet_02_Scripts.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/4.0.1/chart.umd.js" integrity="sha512-gQhCDsnnnUfaRzD8k1L5llCCV6O9HN09zClIzzeJ8OJ9MpGmIlCxm+pdCkqTwqJ4JcjbojFr79rl2F1mzcoLMQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
2+
<!-- Add chartjs-plugin-datalabels.min.js reference if chart components with data label feature is used in your application. -->
3+
<script src="https://cdnjs.cloudflare.com/ajax/libs/chartjs-plugin-datalabels/2.2.0/chartjs-plugin-datalabels.min.js" integrity="sha512-JPcRR8yFa8mmCsfrw4TNte1ZvF1e3+1SdGMslZvmrzDYxS69J7J49vkFL8u6u8PlPJK+H3voElBtUCzaXj+6ig==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
4+
<script src="_content/BlazorExpress.ChartJS/blazorexpress.chartjs.js"></script>

‎BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_02_WebApp_Server_Global/Getting_Started_Snippet_03_Register.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@using BlazorExpress.ChartJS

‎BlazorExpress.ChartJS.Demo.RCL/Components/Pages/GettingStarted/NET8_03_WebApp_Auto/GettingStarted.razor‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
@attribute [Route(pageUrl)]
2+
3+
<PageHeroSection PageUrl="@pageUrl"
4+
Title="@title"
5+
Heading="@heading"
6+
Description="@description"
7+
ImageUrl="@imageUrl" />
8+
9+
<SectionHeading Size="HeadingSize.H3" Text="Client Project" PageUrl="@pageUrl" HashTagName="client-project" />
10+
11+
<SectionHeading Size="HeadingSize.H4" Text="Install Nuget Package" PageUrl="@pageUrl" HashTagName="install-nuget-package" />
12+
<div class="mb-3">
13+
Looking to quickly add <b>BlazorExpress.ChartJS</b> to your project? Use NuGet package manager.
14+
</div>
15+
<Snippet LanguageCode="LanguageCode.PowerShell" FilePath="~\Components\Pages\GettingStarted\NET8_02_WebApp_Server_Global\Getting_Started_Snippet_01_Install.txt" />
16+
17+
<SectionHeading Size="HeadingSize.H4" Text="Register services" PageUrl="@pageUrl" HashTagName="register-services" />
18+
<div class="mb-3">
19+
Register tag helpers in <b>_Imports.razor</b>.
20+
</div>
21+
<Snippet LanguageCode="LanguageCode.Razor" FilePath="~\Components\Pages\GettingStarted\NET8_02_WebApp_Server_Global\Getting_Started_Snippet_03_Register.txt" />
22+
23+
<SectionHeading Size="HeadingSize.H3" Text="Server Project" PageUrl="@pageUrl" HashTagName="server-project" />
24+
25+
<SectionHeading Size="HeadingSize.H4" Text="Add script references" PageUrl="@pageUrl" HashTagName="add-script-references" />
26+
<div class="mb-3">
27+
Insert the following references into the <b>body</b> section of the <b>Components/App.razor</b> file, immediately after the <b>_framework/blazor.web.js</b> reference:
28+
</div>
29+
<Snippet LanguageCode="LanguageCode.JavaScript" FilePath="~\Components\Pages\GettingStarted\NET8_02_WebApp_Server_Global\Getting_Started_Snippet_02_Scripts.html" />
30+
31+
@code {
32+
private const string pageUrl = "/charts/getting-started/blazor-webapp-auto-global-net-8";
33+
private const string title = "Getting started - Blazor WebApp (.NET 8) - Interactive render mode Auto - Global location";
34+
private const string heading = "Getting started - Blazor WebApp (.NET 8) - Interactive render mode Auto - Global location";
35+
private const string description = "Get started with the Enterprise-class Component library built on the Blazor and Chart.js JavaScript library.";
36+
private const string imageUrl = "https://i.imgur.com/C5ObC3A.png";
37+
}

0 commit comments

Comments
 (0)