Skip to content

Commit e533e95

Browse files
Merge pull request #6712 from syncfusion-content/983717-UG-docs-Ribbon-4
983717: Enhanced the blazor documentation for Ribbon
2 parents eb17588 + 57e9912 commit e533e95

File tree

5 files changed

+45
-45
lines changed

5 files changed

+45
-45
lines changed

blazor/ribbon/keytip.md

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

1010
# KeyTips in Blazor Ribbon component
1111

12-
The Blazor Ribbon component supports keyboard navigation through KeyTips, enabling users to interact with Ribbon interface without using a mouse. KeyTips can be enabled by setting the `EnableKeyTips` property, allowing users to quickly access commands using shortcut keys.
12+
The Blazor Ribbon component supports keyboard navigation through keytips, enabling users to interact with the Ribbon interface without a mouse. Keytips can be enabled by setting the `EnableKeyTips` property, allowing users to quickly access commands using keyboard shortcuts.
1313

1414
The keyTips will be shown when the **Alt + Windows/Command(on macOS)** keys are pressed.
1515

1616
## KeyTips for different ribbon elements
1717

1818
### Ribbon items keytip
1919

20-
You can add keytips to the Ribbon items by using the `KeyTip` property in the `RibbonItem` directive.
20+
Keytips can be added to Ribbon items by using the `KeyTip` property in the `RibbonItem` directive.
2121

2222
{% tabs %}
2323
{% highlight razor %}
@@ -275,11 +275,11 @@ You can add keytips to the Ribbon items by using the `KeyTip` property in the `R
275275
{% endhighlight %}
276276
{% endtabs %}
277277

278-
![Ribbon Items Keytip](./images/keytip/items-keytip.png)
278+
![Ribbon items keytip](./images/keytip/items-keytip.png)
279279

280280
### File menu keytip
281281

282-
You can add keytip to the File menu by using the `KeyTip` property.
282+
A keytip can be added to the File menu by using the `KeyTip` property.
283283

284284
{% tabs %}
285285
{% highlight razor %}
@@ -346,11 +346,11 @@ You can add keytip to the File menu by using the `KeyTip` property.
346346
{% endhighlight %}
347347
{% endtabs %}
348348

349-
![Ribbon File Menu Keytip](./images/keytip/file-menu-keytip.png)
349+
![Ribbon file menu keytip](./images/keytip/file-menu-keytip.png)
350350

351351
### Backstage menu keytip
352352

353-
You can add keytips for the backstage button and menu items by using `KeyTip` property.
353+
Keytips can be added for the backstage button and menu items by using the `KeyTip` property.
354354

355355
{% tabs %}
356356
{% highlight razor %}
@@ -418,11 +418,11 @@ You can add keytips for the backstage button and menu items by using `KeyTip` pr
418418
{% endhighlight %}
419419
{% endtabs %}
420420

421-
![Ribbon Backstage menu keytip](./images/keytip/backstage-keytip.png)
421+
![Ribbon backstage menu keytip](./images/keytip/backstage-keytip.png)
422422

423423
### Ribbon layout switcher keytip
424424

425-
You can add keytip to the layout switcher by using the `LayoutSwitcherKeyTip` property for switching between **Classic** and **Simplified** Ribbon layouts.
425+
A keytip can be added to the layout switcher by using the `LayoutSwitcherKeyTip` property to switch between the `Classic` and `Simplified` Ribbon layouts.
426426

427427
{% tabs %}
428428
{% highlight razor %}
@@ -493,7 +493,7 @@ You can add keytip to the layout switcher by using the `LayoutSwitcherKeyTip` pr
493493

494494
### Ribbon launcher icon keytip
495495

496-
You can add keytip to the launcher icon by using `LauncherIconKeyTip` property allowing you to quickly open additional options in Ribbon groups.
496+
A keytip can be added to the launcher icon by using the `LauncherIconKeyTip` property to quickly open additional options in Ribbon groups.
497497

498498
{% tabs %}
499499
{% highlight razor %}
@@ -567,14 +567,14 @@ You can add keytip to the launcher icon by using `LauncherIconKeyTip` property a
567567

568568
### Show keytips
569569

570-
You can use the `ShowKeyTipsAsync` method to dynamically display keytips.
570+
The `ShowKeyTipsAsync` method displays keytips dynamically for the Ribbon.
571571

572572
- To activate a specific key action, pass the corresponding keytip string as an argument.
573573
- For example, calling `ShowKeyTipsAsync('H')` will look for the specific item associated with the **H** key and trigger its respective action.
574574

575575
### Hide keytips
576576

577-
You can use the `HideKeyTipsAsync` method to remove all visible keytips from the Ribbon dynamically.
577+
The `HideKeyTipsAsync` method removes all visible keytips from the Ribbon dynamically.
578578

579579
{% tabs %}
580580
{% highlight razor %}
@@ -654,16 +654,16 @@ You can use the `HideKeyTipsAsync` method to remove all visible keytips from the
654654
{% endhighlight %}
655655
{% endtabs %}
656656

657-
![Ribbon Show Hide keytips](./images/show-hide-keytip.png)
657+
![Ribbon show and hide keytips](./images/keytip/show-hide-keytip.png)
658658

659659
## Guidelines for adding keytips
660660

661-
Before adding keytips to the Ribbon items, follow these best practices:
661+
Before adding keytips to Ribbon items, follow these best practices:
662662

663-
* Avoid using the same keytip setting on multiple items.
663+
* Avoid assigning the same keytip to multiple items.
664664

665-
> Each keytip should be distinct. If multiple items share the same keytip (e.g., `H` or `HF`), only the first occurrence will be activated, while any subsequent instances of H or HF are ignored.
665+
> Each keytip must be unique. If multiple items share the same keytip (for example, `H` or `HF`), only the first occurrence is activated; subsequent items using the same keytip are ignored.
666666
667-
* Do not use the same first letter for the single and double keytip items.
667+
* Do not use the same first letter for single- and multi-character keytips on different items.
668668

669-
> When using multi-character keytips (e.g., `F`, `FP`, and `FPF`) for different items, pressing `F` will activate only the first-level keytip (`F`), while `FP` and `FPF` will be ignored.
669+
> When using multi-character keytips (for example, `F`, `FP`, and `FPF`) for different items, pressing `F` activates only the first-level keytip (`F`), and `FP` and `FPF` are ignored.

blazor/ribbon/layouts.md

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

1010
# Layouts in Blazor Ribbon component
1111

12-
The Ribbon component allows customization of its layout through the [ActiveLayout](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_ActiveLayout) property. It supports two primary layouts: `Classic` and `Simplified`.
12+
The Ribbon component supports customizable layouts through the [ActiveLayout](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_ActiveLayout) property. Two primary layouts are available: `Classic` and `Simplified`.
1313

1414
## Classic layout
1515

16-
The Classic layout organizes Ribbon items and groups in a traditional format. You can set the [ActiveLayout](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_ActiveLayout) property to `RibbonLayout.Classic` to enable this layout. By default, the Ribbon component renders in the `Classic` layout.
16+
The Classic layout organizes Ribbon items and groups in a traditional, multi-row format with group headers and collections. Set the [ActiveLayout](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_ActiveLayout) property to `RibbonLayout.Classic` to enable this layout. By default, the Ribbon renders in the `Classic` layout.
1717

1818
{% tabs %}
1919
{% highlight razor %}
@@ -73,13 +73,13 @@ The Classic layout organizes Ribbon items and groups in a traditional format. Yo
7373

7474
### Defining items size
7575

76-
You can control the size of Ribbon items using the [AllowedSizes](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html#Syncfusion_Blazor_Ribbon_RibbonItem_AllowedSizes) property in the [RibbonItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html) directive. The Ribbon supports three item sizes:
76+
Control the size of Ribbon items using the [AllowedSizes](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html#Syncfusion_Blazor_Ribbon_RibbonItem_AllowedSizes) property in the [RibbonItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html) directive. The Ribbon supports three item sizes:
7777

7878
- **Large**: Large icon with text.
7979
- **Medium**: Small icon with text.
8080
- **Small**: Small icon only.
8181

82-
When resizing to smaller screen, the item sizes adjust based on the available tab content width in the order: Large → Medium → Small, and vice versa.
82+
When resizing to a smaller screen, item sizes adapt based on the available tab content width in the order Large → Medium → Small, and vice versa when space increases.
8383

8484
{% tabs %}
8585
{% highlight razor %}
@@ -139,10 +139,10 @@ When resizing to smaller screen, the item sizes adjust based on the available ta
139139

140140
### Defining items orientation
141141

142-
You can use the [Orientation](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_Orientation) property of the [RibbonGroup](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html) tag directive to arrange items vertically (Column) or horizontally (Row). By default, the orientation is `Column`.
142+
Use the [Orientation](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_Orientation) property of the [RibbonGroup](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html) tag directive to arrange items vertically (Column) or horizontally (Row). The default orientation is `Column`.
143143

144-
Row: A group may have up to three collections, each containing multiple items.
145-
Column: A group can have any number of collections, with each collection containing one large-sized item or up to three medium/small-sized items.
144+
- Row: A group may contain up to three collections, and each collection can include multiple items.
145+
- Column: A group can contain any number of collections. Each collection can include either one large-sized item or up to three medium/small-sized items.
146146

147147
{% tabs %}
148148
{% highlight razor %}
@@ -261,15 +261,15 @@ Column: A group can have any number of collections, with each collection contain
261261

262262
### Defining group properties
263263

264-
You can customize the appearance and functionalities of Ribbon groups by using properties of [RibbonGroup](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html) such as `HeaderText`, `GroupIconCss`, `ShowLauncherIcon`, `IsCollapsible` and `Priority`.
264+
Customize the appearance and functionality of Ribbon groups using [RibbonGroup](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html) properties such as `HeaderText`, `GroupIconCss`, `ShowLauncherIcon`, `IsCollapsible`, and `Priority`.
265265

266266
|Name|DataType|Description|
267267
|---|---|---|
268-
|[HeaderText](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_HeaderText)|string|Defines the text that appears as the header for the group|
269-
|[GroupIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_GroupIconCss)|string|Icon that appears in group popup button while resizing|
270-
|[ShowLauncherIcon](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_ShowLauncherIcon)|boolean|Enables or disables the launcher icon for each group. By default, the property is set to `false`|
271-
|[IsCollapsible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_IsCollapsible)|boolean|Controls whether a group can be collapsed or not during resizing. By default, the property is set to `true`|
272-
|[Priority](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_Priority)|int|Determines the collapse and expand order of groups during resizing. Higher priority values collapse first, while lower values expand first|
268+
|[HeaderText](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_HeaderText)|string|Defines the text that appears as the header for the group.|
269+
|[GroupIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_GroupIconCss)|string|Specifies the icon displayed in the group popup button during resizing.|
270+
|[ShowLauncherIcon](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_ShowLauncherIcon)|bool|Enables or disables the launcher icon for the group. By default, this property is set to `false`.|
271+
|[IsCollapsible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_IsCollapsible)|bool|Controls whether a group can be collapsed during resizing. By default, this property is set to `true`.|
272+
|[Priority](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_Priority)|int|Determines the collapse/expand order during resizing. Higher values collapse first; lower values expand first.|
273273

274274
{% tabs %}
275275
{% highlight razor %}
@@ -388,7 +388,7 @@ You can customize the appearance and functionalities of Ribbon groups by using p
388388

389389
## Simplified layout
390390

391-
In simplified layout, the Ribbon component organizes the items and groups into a single row. Set the [ActiveLayout](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_ActiveLayout) property to `RibbonLayout.Simplified` to enable this layout.
391+
In the Simplified layout, the Ribbon organizes items and groups into a single row to save vertical space and emphasize frequently used commands. Set the [ActiveLayout](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_ActiveLayout) property to `RibbonLayout.Simplified` to enable this layout.
392392

393393
{% tabs %}
394394
{% highlight razor %}
@@ -448,7 +448,7 @@ In simplified layout, the Ribbon component organizes the items and groups into a
448448

449449
### Enabling group overflow popup
450450

451-
You can control how overflow items appear in the group while resizing using the [EnableGroupOverflow](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_EnableGroupOverflow) property.
451+
Control how overflow items appear within a group during resizing using the [EnableGroupOverflow](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonGroup.html#Syncfusion_Blazor_Ribbon_RibbonGroup_EnableGroupOverflow) property.
452452

453453
- Set to `true` to display overflow items in a separate popup near the group.
454454
- Set to `false` to display overflow items in a common popup at the right end of the tab content.
@@ -570,9 +570,9 @@ You can control how overflow items appear in the group while resizing using the
570570

571571
## Minimized state
572572

573-
You can hide the Ribbon contents and display only the tab headers by double-clicking on the tab header. When the Ribbon is on minimized state, it expands to its normal state when click on the tab header.
573+
Hide Ribbon contents and display only the tab headers by double-clicking a tab header to toggle the minimized state. When the Ribbon is in a minimized state, clicking a tab header temporarily expands the content; the Ribbon returns to the minimized state when focus moves away.
574574

575-
Also, you can programmatically control the minimized state of Ribbon using the [IsMinimized](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_IsMinimized) property. By default, the value is `false`.
575+
The minimized state can also be controlled programmatically using the [IsMinimized](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_IsMinimized) property. By default, this property is set to `false`.
576576

577577
{% tabs %}
578578
{% highlight razor %}
@@ -632,7 +632,7 @@ Also, you can programmatically control the minimized state of Ribbon using the [
632632

633633
## Show or hide the layout switcher
634634

635-
You can use the [HideLayoutSwitcher](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_HideLayoutSwitcher) property to show/hide the Ribbon layout switcher button. By default, the value is `false`, meaning the switcher will be visible.
635+
Use the [HideLayoutSwitcher](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.SfRibbon.html#Syncfusion_Blazor_Ribbon_SfRibbon_HideLayoutSwitcher) property to show or hide the Ribbon layout switcher button. By default, this property is set to `false`, so the switcher is visible.
636636

637637
{% tabs %}
638638
{% highlight razor %}

blazor/ribbon/resizing.md

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

1010
# Resizing in Blazor Ribbon component
1111

12-
The Ribbon dynamically adjusts its elements during resizing. When the ribbon's size increases, elements expand, and when it decreases, elements collapse. Resizing is supported in both Classic and Simplified modes, with the flexibility to customize the order in which elements resize.
12+
The Ribbon dynamically adjusts item sizes when the available width changes. As space increases, items expand; as space decreases, items reduce in size. Resizing is supported in both Classic mode and Simplified mode. The sizes that an item can take during resizing can be constrained using the AllowedSizes property.
1313

14-
- **Classic Mode**: During resizing, the size of items adjusts sequentially based on the available width of the tab content in the order: `Large → Medium → Small` (and vice versa).
15-
- **Simplified Mode**: During resizing, the size of items adjusts sequentially in the order: `Medium → Small` (and vice versa).
14+
- **Classic mode**: During resizing, item sizes adjust sequentially based on the available width of the tab content in the order: Large → Medium → Small (and vice versa).
15+
- **Simplified mode**: During resizing, item sizes adjust sequentially in the order: Medium → Small (and vice versa). In Simplified mode, the Large size is not used.
1616

1717
## Defining items allowed size
1818

19-
You can use the [AllowedSizes](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html#Syncfusion_Blazor_Ribbon_RibbonItem_AllowedSizes) property within [RibbonItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html) to specify the sizes that an item can maintain during resizing. When set, the item's size remains constant within the defined value, irrespective of resizing.
19+
Use the [AllowedSizes](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html#Syncfusion_Blazor_Ribbon_RibbonItem_AllowedSizes) property on a [RibbonItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html) to restrict the sizes that the item can take during resizing. When set, the item only switches among the specified sizes, regardless of overall Ribbon resizing.
2020

2121
{% tabs %}
2222
{% highlight razor %}
@@ -53,4 +53,4 @@ You can use the [AllowedSizes](https://help.syncfusion.com/cr/blazor/Syncfusion.
5353

5454
## Defining items active size
5555

56-
The [ActiveSize](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html#Syncfusion_Blazor_Ribbon_RibbonItem_ActiveSize) property within [RibbonItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html) indicates the current size of the rendered item. By default, the value is `Medium`. It is a read-only property.
56+
The [ActiveSize](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html#Syncfusion_Blazor_Ribbon_RibbonItem_ActiveSize) property on a [RibbonItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Ribbon.RibbonItem.html) indicates the current size of the rendered item. By default, the value is Medium. This property is read-only and reflects the item’s current state during resizing.

0 commit comments

Comments
 (0)