Skip to content

Commit b4e7ba8

Browse files
Merge pull request #311 from syncfusion-content/958396-Update-UG-content
Reviewed the UG content for the common files
2 parents f54fdc7 + de631cd commit b4e7ba8

File tree

6 files changed

+58
-64
lines changed

6 files changed

+58
-64
lines changed

maui-toolkit/Installation.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
---
22
layout: post
3-
title: Install Syncfusion® Maui Toolkit NuGet packages - Syncfusion®
4-
description: Learn here about the how to install Syncfusion® Maui Toolkit NuGet packages from Package manager and NuGet manager.
3+
title: Install Syncfusion® MAUI Toolkit NuGet Packages - Syncfusion®
4+
description: Learn how to install Syncfusion® MAUI Toolkit NuGet packages from Package manager and NuGet manager.
55
platform: maui-toolkit
66
component: Common
7-
documentation: ug
7+
documentation: UG
88
---
99

10-
# Install Syncfusion<sup>®</sup> Maui Toolkit NuGet packages
11-
12-
## Overview
10+
# Install Syncfusion<sup>®</sup> MAUI Toolkit NuGet Packages
1311

1412
NuGet is a package management system used in Visual Studio, simplifying the process of adding, updating, and removing external libraries in your applications. Syncfusion<sup>®</sup> publishes the **Syncfusion.Maui.Toolkit** NuGet package, which can be found on [nuget.org](https://www.nuget.org/packages?q=Syncfusion.Maui.Toolkit).
1513

1614
## Installation using Package Manager UI
1715

18-
The **NuGet Package Manager UI** allows you to search for, install, uninstall, and update Syncfusion<sup>®</sup> Maui Toolkit packages easily. Follow these steps to install the Syncfusion.Maui.Toolkit package in your MAUI application:
16+
The **NuGet Package Manager UI** allows you to search for, install, uninstall, and update Syncfusion<sup>®</sup> MAUI Toolkit packages easily. Follow these steps to install the Syncfusion.Maui.Toolkit package in your MAUI application:
1917

2018
1. Right-click on your MAUI application or solution in the Solution Explorer and select **Manage NuGet Packages...**
2119

@@ -27,17 +25,17 @@ The **NuGet Package Manager UI** allows you to search for, install, uninstall, a
2725

2826
N> Ensure that [nuget.org](https://api.nuget.org/v3/index.json) is selected as the package source. If not, follow the [instructions](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio#package-sources) to configure it.
2927

30-
![Maui NuGet Packages Search](images/NuGetsearch.png)
28+
![MAUI NuGet Packages Search](images/NuGetsearch.png)
3129

3230
3. Select the **Syncfusion.Maui.Toolkit** package, choose the appropriate version, and click **Install**. Accept the license terms to complete the installation.
3331

34-
![Maui NuGet Packages Install](images/InstallNuGet.png)
32+
![MAUI NuGet Packages Install](images/InstallNuGet.png)
3533

3634
4. Once the installation is complete, your application will have all the necessary **Syncfusion<sup>®</sup> assemblies** required to begin developing using the **Syncfusion<sup>®</sup> .NET MAUI Toolkit components**.
3735

3836
## Installation using Dotnet (.NET) CLI
3937

40-
The [.NET Command Line Interface (CLI)](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-dotnet-cli), allows you to add, restore, and manage packages without making changes to your project files manually. Here are the steps to install the **Syncfusion.Maui.Toolkit** package using the .NET CLI:
38+
The [.NET Command Line Interface (CLI)](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-dotnet-cli) allows you to add, restore, and manage packages without making changes to your project files manually. Here are the steps to install the **Syncfusion.Maui.Toolkit** package using the .NET CLI:
4139

4240
Follow the below instructions to use the dotnet CLI command to install the Syncfusion<sup>®</sup> Maui NuGet packages.
4341

@@ -54,7 +52,7 @@ Follow the below instructions to use the dotnet CLI command to install the Syncf
5452

5553
3. After installation, inspect the `.csproj` file of your project to confirm the package has been added.
5654

57-
![Maui Package Entry ](images/packageentry.png)
55+
![MAUI Package Entry ](images/packageentry.png)
5856

5957
4. Run [dotnet restore](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-restore?tabs=netcore2x) to install all dependencies and ensure that your project is ready.
6058

@@ -70,16 +68,14 @@ The **Package Manager Console** provides an efficient way to install the **Sync
7068

7169
```Install-Package Syncfusion.Maui.Toolkit```
7270

73-
![Package Manager Console Output ](images/ConsoleInstallationOutput.png)
71+
![Package Manager Console output ](images/ConsoleInstallationOutput.png)
7472

7573
N> To specify the version or target a specific project, use:
7674

7775
```Install-Package Syncfusion.Maui.Toolkit -Version 1.0.0 - ProjectName <Project Name>```
7876

79-
![Package Manager Console Output ](images/ConsoleInstallationProjectOutput.png)
77+
![Package Manager Console output ](images/ConsoleInstallationProjectOutput.png)
8078

8179
3. Once the installation completes, the console will display confirmation, and your application will now have access to the **Syncfusion<sup>®</sup> .NET MAUI Toolkit components**.
8280

8381
4. Your application is now ready to leverage the high-performance and responsive components of the **Syncfusion<sup>®</sup> .NET MAUI Toolkit**.
84-
85-

maui-toolkit/Introduction/Overview.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
---
22
layout: post
33
title: Comprehensive Guide to Syncfusion® Toolkit for .NET MAUI
4-
description: Overview of the Syncfusion® .NET MAUI Toolkit, detailed steps on how to read the user guide effectively, and supported platforms
4+
description: Overview of the Syncfusion® .NET MAUI Toolkit, detailed steps on how to read the user guide effectively, and supported platforms.
55
platform: maui-toolkit
66
control: Overview
7-
documentation: ug
7+
documentation: UG
88
---
99

1010
# Welcome to Syncfusion<sup>®</sup> Toolkit for .NET MAUI
1111

12-
Syncfusion<sup>®</sup> Toolkit for .NET MAUI is a comprehensive collection of .NET MAUI components for building modern Mobile and Desktop applications. It includes our first set of .NET MAUI UI controls such as Charts, Navigation Drawer, and Tab View.
12+
The Syncfusion<sup>®</sup> Toolkit for .NET MAUI is a comprehensive collection of .NET MAUI components for building modern Mobile and Desktop applications. It includes our first set of .NET MAUI UI controls such as Charts, Navigation Drawer, and Tab View.
1313

1414
## How to read this user guide most effectively
1515

16-
* Start with the "Getting Started" section for the component you need, as it provides key information before writing code.
16+
* Start with the "Getting Started" section for the component you need, as it provides key information before you begin code.
1717
* After understanding the basics, refer to the sample browser for code examples related to your use case.
1818
* For specific features or API details, use the search box at the top of the user guide.
1919
* Utilize the API reference for detailed information on classes and their members when needed.
2020

2121
## Supported platforms for .NET MAUI apps
2222

23-
.NET Multi-platform App UI (.NET MAUI) apps can be written for the following platforms:
23+
.NET Multi-platform App UI (.NET MAUI) apps can be developed for the following platforms:
2424

25-
* Android 5.0 (API 21) or higher is required.
26-
* iOS 12.2 or higher is required.
25+
* Android 5.0 (API 21) or higher.
26+
* iOS 12.2 or higher.
2727
* macOS 12 or higher, using Mac Catalyst.
2828
* Windows 11 and Windows 10 version 1809 or higher, using Windows UI Library (WinUI) 3.
2929

30-
## Supported .NET Versions
30+
## Supported .NET versions
3131

3232
* .NET 9.0
3333
* .NET 8.0

maui-toolkit/Migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Switch from Syncfusion® .NET MAUI to Syncfusion® Toolkit for .NET MAUI
44
description: Describes the necessary changes to easily update the existing Syncfusion® .NET MAUI control to use the new toolkit with minimal code modifications.
55
platform: maui-toolkit
66
control: General
7-
documentation: ug
7+
documentation: UG
88
---
99

1010
# Migration Overview: Syncfusion<sup>®</sup> .NET MAUI to Syncfusion<sup>®</sup> Toolkit for .NET MAUI

maui-toolkit/Themes/HowTo.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
layout: post
3-
title: How to customize theming in Syncfusion® controls
4-
description: Learn here all about how to switch between light and dark themes in Syncfusion® Maui controls, along with additional details on this feature.
3+
title: How to Customize Theming in Syncfusion® Controls
4+
description: Learn how to switch between light and dark themes in Syncfusion® Maui controls, along with additional feature details.
55
platform: maui-toolkit
66
control: General
7-
documentation: ug
7+
documentation: UG
88
---
99

10-
# Switching between light theme and dark theme
10+
# Switching Between Light Theme and Dark Theme
1111

12-
Refer to the following example code to switch between light and dark themes in Syncfusion<sup>®</sup> Maui controls.
12+
Refer to the following example code to switch between light and dark themes in Syncfusion<sup>®</sup> MAUI controls.
1313

1414
{% highlight C# %}
1515
void UpdateTheme(object sender, System.EventArgs e)

maui-toolkit/Themes/Keys.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
layout: post
33
title: About Keys for Syncfusion® Controls | Syncfusion®
4-
description: This section contains the details about the keys which are mapped to the UI elements of all the controls
4+
description: Detailed information on the keys mapped to the UI elements of all Syncfusion® controls.
55
platform: maui-toolkit
66
control: General
7-
documentation: ug
7+
documentation: UG
88
---
99

1010
# Keys of Syncfusion<sup>®</sup> Controls
@@ -106,7 +106,7 @@ This page lists the keys for each control and the element to which it is mapped
106106
</tr>
107107
<tr>
108108
<td>SfCartesianChartBackground<br/><br/></td>
109-
<td>Background color of cartesian chart<br/><br/></td>
109+
<td>Background color of the cartesian chart<br/><br/></td>
110110
</tr>
111111
<tr>
112112
<td>SfCartesianChartMajorGridLineStroke<br/><br/></td>
@@ -324,7 +324,7 @@ This page lists the keys for each control and the element to which it is mapped
324324
<br/>
325325
</td>
326326
<td>
327-
Color of the SfChips background in disable state.
327+
Color of the SfChips background in disabled state.
328328
<br/>
329329
<br/>
330330
</td>
@@ -336,7 +336,7 @@ This page lists the keys for each control and the element to which it is mapped
336336
<br/>
337337
</td>
338338
<td>
339-
Color of the SfChips text in disable state.
339+
Color of the SfChips text in disabled state.
340340
<br/>
341341
<br/>
342342
</td>
@@ -348,7 +348,7 @@ This page lists the keys for each control and the element to which it is mapped
348348
<br/>
349349
</td>
350350
<td>
351-
Color of the clear button icon in disable state.
351+
Color of the clear button icon in disabled state.
352352
<br/>
353353
<br/>
354354
</td>
@@ -360,7 +360,7 @@ This page lists the keys for each control and the element to which it is mapped
360360
<br/>
361361
</td>
362362
<td>
363-
Color of the SfChips stroke in disable state.
363+
Color of the SfChips stroke in disabled state.
364364
<br/>
365365
<br/>
366366
</td>
@@ -372,7 +372,7 @@ This page lists the keys for each control and the element to which it is mapped
372372
<br/>
373373
</td>
374374
<td>
375-
Color of the SfChips selection indicator in disable state.
375+
Color of the SfChips selection indicator in disabled state.
376376
<br/>
377377
<br/>
378378
</td>
@@ -536,7 +536,7 @@ This page lists the keys for each control and the element to which it is mapped
536536
<br/>
537537
</td>
538538
<td>
539-
Color of the SfChipGroup background in disable state.
539+
Color of the SfChipGroup background in disabled state.
540540
<br/>
541541
<br/>
542542
</td>
@@ -548,7 +548,7 @@ This page lists the keys for each control and the element to which it is mapped
548548
<br/>
549549
</td>
550550
<td>
551-
Color of the SfChipGroup text in disable state.
551+
Color of the SfChipGroup text in disabled state.
552552
<br/>
553553
<br/>
554554
</td>
@@ -560,7 +560,7 @@ This page lists the keys for each control and the element to which it is mapped
560560
<br/>
561561
</td>
562562
<td>
563-
Color of the SfChipGroup stroke in disable state.
563+
Color of the SfChipGroup stroke in disabled state.
564564
<br/>
565565
<br/>
566566
</td>
@@ -572,7 +572,7 @@ This page lists the keys for each control and the element to which it is mapped
572572
<br/>
573573
</td>
574574
<td>
575-
Color of the SfChipGroup selected background in disable state.
575+
Color of the SfChipGroup selected background in disabled state.
576576
<br/>
577577
<br/>
578578
</td>
@@ -584,7 +584,7 @@ This page lists the keys for each control and the element to which it is mapped
584584
<br/>
585585
</td>
586586
<td>
587-
Color of the SfChipGroup selected text in disable state.
587+
Color of the SfChipGroup selected text in disabled state.
588588
<br/>
589589
<br/>
590590
</td>
@@ -596,7 +596,7 @@ This page lists the keys for each control and the element to which it is mapped
596596
<br/>
597597
</td>
598598
<td>
599-
Color of the SfChipGroup selection indicator in disable state.
599+
Color of the SfChipGroup selection indicator in disabled state.
600600
<br/>
601601
<br/>
602602
</td>
@@ -642,7 +642,7 @@ This page lists the keys for each control and the element to which it is mapped
642642
</tr>
643643
<tr>
644644
<td>SfCircularChartBackground<br/><br/></td>
645-
<td>Background of circular chart<br/><br/></td>
645+
<td>Background of the circular chart<br/><br/></td>
646646
</tr>
647647
<tr>
648648
<td>SfCircularChartSelectionBrush<br/><br/></td>
@@ -807,7 +807,7 @@ This page lists the keys for each control and the element to which it is mapped
807807
</tr>
808808
<tr>
809809
<td>SfFunnelChartBackground<br/><br/></td>
810-
<td>Background of funnel chart<br/><br/></td>
810+
<td>Background of the funnel chart<br/><br/></td>
811811
</tr>
812812
<tr>
813813
<td>SfFunnelChartSelectionBrush<br/><br/></td>
@@ -1261,7 +1261,7 @@ This page lists the keys for each control and the element to which it is mapped
12611261
</tr>
12621262
<tr>
12631263
<td>SfPyramidChartBackground<br/><br/></td>
1264-
<td>Background color of pyramid chart<br/><br/></td>
1264+
<td>Background color of the pyramid chart<br/><br/></td>
12651265
</tr>
12661266
<tr>
12671267
<td>SfPyramidChartSelectionBrush<br/><br/></td>
@@ -1347,7 +1347,7 @@ This page lists the keys for each control and the element to which it is mapped
13471347
<br/>
13481348
</td>
13491349
<td>
1350-
Color of border in segmented control.
1350+
Color of border in the segmented control.
13511351
<br/>
13521352
<br/>
13531353
</td>
@@ -1360,7 +1360,7 @@ This page lists the keys for each control and the element to which it is mapped
13601360
<br/>
13611361
</td>
13621362
<td>
1363-
Color of text in segmented control.
1363+
Color of text in the segmented control.
13641364
<br/>
13651365
<br/>
13661366
</td>
@@ -1373,7 +1373,7 @@ This page lists the keys for each control and the element to which it is mapped
13731373
<br/>
13741374
</td>
13751375
<td>
1376-
Background color of segmented control.
1376+
Background color of the segmented control.
13771377
<br/>
13781378
<br/>
13791379
</td>
@@ -1464,7 +1464,7 @@ This page lists the keys for each control and the element to which it is mapped
14641464
<br/>
14651465
</td>
14661466
<td>
1467-
Segmented controls border color when it is focused using the keyboard navigation keys.
1467+
Segmented controls border color when it is focused using the keyboard navigation keys.
14681468
<br/>
14691469
<br/>
14701470
</td>
@@ -1503,7 +1503,7 @@ This page lists the keys for each control and the element to which it is mapped
15031503
<br/>
15041504
</td>
15051505
<td>
1506-
Corner radius of segment in segmented control.
1506+
Corner radius of segment in the segmented control.
15071507
<br/>
15081508
<br/>
15091509
</td>
@@ -1516,7 +1516,7 @@ This page lists the keys for each control and the element to which it is mapped
15161516
<br/>
15171517
</td>
15181518
<td>
1519-
Font size of the segment item in segmented control.
1519+
Font size of the segment item in the segmented control.
15201520
<br/>
15211521
<br/>
15221522
</td>
@@ -1529,7 +1529,7 @@ This page lists the keys for each control and the element to which it is mapped
15291529
<br/>
15301530
</td>
15311531
<td>
1532-
Thickness of the border stroke in segmented control, when it is selected.
1532+
Thickness of the border stroke in the segmented control, when it is selected.
15331533
<br/>
15341534
<br/>
15351535
</td>
@@ -2302,7 +2302,7 @@ This page lists the keys for each control and the element to which it is mapped
23022302
<br/>
23032303
</td>
23042304
<td>
2305-
Color of the SfTextInputLayout background in focus state.
2305+
Color of the SfTextInputLayout background in focused state.
23062306
<br/>
23072307
<br/>
23082308
</td>
@@ -2326,7 +2326,7 @@ This page lists the keys for each control and the element to which it is mapped
23262326
<br/>
23272327
</td>
23282328
<td>
2329-
Color of the SfTextInputLayout background in disable state.
2329+
Color of the SfTextInputLayout background in disabled state.
23302330
<br/>
23312331
<br/>
23322332
</td>
@@ -2338,7 +2338,7 @@ This page lists the keys for each control and the element to which it is mapped
23382338
<br/>
23392339
</td>
23402340
<td>
2341-
Color of the SfTextInputLayout stroke in disable state.
2341+
Color of the SfTextInputLayout stroke in disabled state.
23422342
<br/>
23432343
<br/>
23442344
</td>

0 commit comments

Comments
 (0)