Skip to content

Commit ef890cc

Browse files
Merge pull request #6711 from syncfusion-content/983717-UG-docs-Ribbon-3
983717: Enhanced the blazor documentation for Ribbon
2 parents 357f14d + 62c25f9 commit ef890cc

File tree

4 files changed

+102
-98
lines changed

4 files changed

+102
-98
lines changed

blazor/ribbon/getting-started-webapp.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ control: Ribbon
77
documentation: ug
88
---
99

10-
# Getting Started with Blazor Ribbon in Blazor Web App
10+
# Getting Started with Blazor Ribbon in a Blazor Web App
1111

12-
This section briefly explains about how to include [Blazor Ribbon](https://www.syncfusion.com/blazor-components/blazor-ribbon) component in your Blazor Web App using [Visual Studio](https://visualstudio.microsoft.com/vs/) and Visual Studio Code.
12+
This section explains how to add the [Blazor Ribbon](https://www.syncfusion.com/blazor-components/blazor-ribbon) component to your Blazor Web App using [Visual Studio](https://visualstudio.microsoft.com/vs/) or Visual Studio Code.
1313

14-
To get started quickly with Blazor Ribbon component, check on the following video:
14+
To get started quickly with the Blazor Ribbon component, refer to the following video guide:
1515

1616
{% youtube
1717
"youtube:https://www.youtube.com/watch?v=bJCpW22KqJM" %}
@@ -32,11 +32,13 @@ You need to configure the corresponding [Interactive render mode](https://learn.
3232

3333
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Ribbon and Themes NuGet in the App
3434

35-
To add **Blazor Ribbon** component in the app, open the NuGet package manager in Visual Studio (*Tools → NuGet Package Manager → Manage NuGet Packages for Solution*), search and install [Syncfusion.Blazor.Ribbon](https://www.nuget.org/packages/Syncfusion.Blazor.Ribbon/) and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/).
35+
To add the Blazor Ribbon component, install the `Syncfusion.Blazor.Ribbon` and `Syncfusion.Blazor.Themes` NuGet packages.
3636

37-
If you utilize `WebAssembly or Auto` render modes in the Blazor Web App need to be install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components NuGet packages within the client project.
37+
N> When using the `WebAssembly` or `Auto` render mode, it is required to install the necessary NuGet packages in the client project.
3838

39-
Alternatively, you can utilize the following package manager command to achieve the same.
39+
Open the NuGet package manager in Visual Studio (*Tools → NuGet Package Manager → Manage NuGet Packages for Solution*), search for and install [Syncfusion.Blazor.Ribbon](https://www.nuget.org/packages/Syncfusion.Blazor.Ribbon/) and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/).
40+
41+
Alternatively, you can use the Package Manager Console:
4042

4143
{% tabs %}
4244
{% highlight C# tabtitle="Package Manager" %}
@@ -121,9 +123,10 @@ Import the `Syncfusion.Blazor` and `Syncfusion.Blazor.Ribbon` namespace.
121123
{% endhighlight %}
122124
{% endtabs %}
123125

124-
Now, register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Service in the **~/Program.cs** file of your Blazor Web App.
126+
Next, register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor service in **~/Program.cs**.
125127

126-
If the **Interactive Render Mode** is set to `WebAssembly` or `Auto`, you need to register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor service in both **~/Program.cs** files of your Blazor Web App.
128+
* For `Server` render mode, register the service in the server project's `Program.cs`.
129+
* For `WebAssembly` or `Auto` render modes, you must register the service in *both* the server and client (`.Client`) project `Program.cs` files.
127130

128131
{% tabs %}
129132
{% highlight c# tabtitle="Server(~/_Program.cs)" hl_lines="3 11" %}
@@ -178,7 +181,7 @@ var app = builder.Build();
178181
{% endhighlight %}
179182
{% endtabs %}
180183

181-
## Add stylesheet and script resources
184+
## Add Stylesheet and Script Resources
182185

183186
The theme stylesheet and script can be accessed from NuGet through [Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets). Include the stylesheet reference in the `<head>` section and the script reference at the end of the `<body>` in the **~/Components/App.razor** file as shown below:
184187

@@ -196,16 +199,15 @@ The theme stylesheet and script can be accessed from NuGet through [Static Web A
196199

197200
N> Check out the [Blazor Themes](https://blazor.syncfusion.com/documentation/appearance/themes) topic to discover various methods ([Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets), [CDN](https://blazor.syncfusion.com/documentation/appearance/themes#cdn-reference), and [CRG](https://blazor.syncfusion.com/documentation/common/custom-resource-generator)) for referencing themes in your Blazor application. Also, check out the [Adding Script Reference](https://blazor.syncfusion.com/documentation/common/adding-script-references) topic to learn different approaches for adding script references in your Blazor application.
198201

199-
## Add Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Ribbon component
202+
## Add Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Ribbon Component
200203

201204
Add the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Ribbon component in the **~Pages/.razor** file. If an interactivity location as `Per page/component` in the web app, define a render mode at the top of the `~Pages/.razor` component, as follows:
202205

203-
| Interactivity location | RenderMode | Code |
206+
| Interactivity Location | RenderMode | Code |
204207
| --- | --- | --- |
205-
| Per page/component | Auto | @rendermode InteractiveAuto |
206-
| | WebAssembly | @rendermode InteractiveWebAssembly |
207-
| | Server | @rendermode InteractiveServer |
208-
| | None | --- |
208+
| Per page/component | Auto | `@rendermode InteractiveAuto` |
209+
| | WebAssembly | `@rendermode InteractiveWebAssembly` |
210+
| | Server | `@rendermode InteractiveServer` |
209211

210212
N> If an **Interactivity Location** is set to `Global` and the **Render Mode** is set to `Auto` or `WebAssembly` or `Server`, the render mode is configured in the `App.razor` file by default.
211213

@@ -218,9 +220,9 @@ N> If an **Interactivity Location** is set to `Global` and the **Render Mode** i
218220
{% endhighlight %}
219221
{% endtabs %}
220222

221-
### Adding ribbon tab
223+
### Adding a Ribbon Tab
222224

223-
In Ribbon component, options are organized into tabs for easy access. You can use the [RibbonTabs](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonTabs.html) tag directive to group all the tabs and [RibbonTab](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonTab.html) tag directive to define each ribbon tab as shown below:
225+
Options in the ribbon are organized into tabs. Use the [RibbonTabs](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonTabs.html) tag to group all tabs and the [RibbonTab](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonTab.html) tag for each individual tab.
224226

225227
{% tabs %}
226228
{% highlight razor %}
@@ -254,9 +256,9 @@ To define a ribbon group under each tab, you can use the [RibbonGroups](https://
254256
{% endhighlight %}
255257
{% endtabs %}
256258

257-
### Adding ribbon item
259+
### Adding a Ribbon Item
258260

259-
You can use the [RibbonCollection](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonCollection.html) tag directive to define each ribbon collection that contains one or more items. To define each ribbon item, you can use the [RibbonItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html) tag directive with the [Type](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_Orientation) property to specify the type of item to be rendered, using the [RibbonItemType](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_Orientation) such as Button, a DropDown, a ComboBox, and more.
261+
Within a group, items are organized into collections. Use the [RibbonCollection](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonCollection.html) tag ditective for a set of items and the [RibbonItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html) tag directive for each individual item. The [Type](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_Orientation) property specifies the kind of item to render, such as a Button, DropDown, or ComboBox.
260262

261263
{% tabs %}
262264
{% highlight razor %}

blazor/ribbon/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Getting Started with Blazor Ribbon Component
1111

12-
This section briefly explains about how to include [Blazor Ribbon](https://www.syncfusion.com/blazor-components/blazor-ribbon) component in your Blazor WebAssembly App using Visual Studio and Visual Studio Code.
12+
This guide explains how to add the [Blazor Ribbon](https://www.syncfusion.com/blazor-components/blazor-ribbon) component in your Blazor WebAssembly App using Visual Studio and Visual Studio Code.
1313

1414
{% tabcontents %}
1515

@@ -21,7 +21,7 @@ This section briefly explains about how to include [Blazor Ribbon](https://www.s
2121

2222
## Create a new Blazor App in Visual Studio
2323

24-
You can create a **Blazor WebAssembly App** using Visual Studio via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-7.0) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-integration/template-studio).
24+
To create a **Blazor WebAssembly App** using Visual Studio via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-7.0) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-integration/template-studio).
2525

2626
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Ribbon and Themes NuGet in the App
2727

@@ -48,7 +48,7 @@ N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are availa
4848

4949
## Create a new Blazor App in Visual Studio Code
5050

51-
You can create a **Blazor WebAssembly App** using Visual Studio Code via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-7.0&pivots=vsc) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-code-integration/create-project).
51+
To create a **Blazor WebAssembly App** using Visual Studio Code via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-7.0&pivots=vsc) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-code-integration/create-project).
5252

5353
Alternatively, you can create a WebAssembly application using the following command in the terminal(<kbd>Ctrl</kbd>+<kbd>`</kbd>).
5454

@@ -66,7 +66,7 @@ cd BlazorApp
6666
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Ribbon and Themes NuGet in the App
6767

6868
* Press <kbd>Ctrl</kbd>+<kbd>`</kbd> to open the integrated terminal in Visual Studio Code.
69-
* Ensure you’re in the project root directory where your `.csproj` file is located.
69+
* Ensure the current working directory is the project root, where the `.csproj` file is located.
7070
* Run the following command to install a [Syncfusion.Blazor.Ribbon](https://www.nuget.org/packages/Syncfusion.Blazor.Ribbon) and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/) NuGet package and ensure all dependencies are installed.
7171

7272
{% tabs %}
@@ -232,6 +232,6 @@ You can use the [RibbonCollection](https://help.syncfusion.com/cr/blazor/Syncfus
232232

233233
{% previewsample "https://blazorplayground.syncfusion.com/embed/LZrJCLsRVGKvCOVj?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
234234

235-
* Press <kbd>Ctrl</kbd>+<kbd>F5</kbd> (Windows) or <kbd>⌘</kbd>+<kbd>F5</kbd> (macOS) to launch the application. This will render the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Ribbon component in your default web browser.
235+
Press <kbd>Ctrl</kbd>+<kbd>F5</kbd> (Windows) or <kbd>⌘</kbd>+<kbd>F5</kbd> (macOS) to run the application. The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Ribbon component will be rendered in your default web browser.
236236

237237
![Blazor Ribbon Component](./images/getting-started.png)

blazor/ribbon/help-pane-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ documentation: ug
1212

1313
# Help Pane in Blazor Ribbon component
1414

15-
The help pane is dedicated area where the users can define help contents like controlling document permissions, sharing features, and more which appears on the right side of the Ribbon. You can use the [HelpPaneTemplate][HelpPaneTemplate] tag directive within the [SfRibbon][SfRibbon] to set the help pane contents.
15+
The Ribbon component includes a help pane, a dedicated area on the right for displaying custom content. This content can include action buttons, help text, or other UI elements. To define the content for this area, use the [HelpPaneTemplate][HelpPaneTemplate] tag directive within the [SfRibbon][SfRibbon] component.
1616

1717
{% tabs %}
1818
{% highlight razor %}

0 commit comments

Comments
 (0)