syncfusion/blazor-ui-components-skills / skills/syncfusion-blazor-ribbon
syncfusion-blazor-ribbon
VerifiedImplement the Syncfusion Blazor Ribbon component. Use this skill when creating ribbon interfaces, implementing ribbon tabs/groups/items, adding file menus, handling ribbon events, or customizing ribbon styling in Syncfusion Blazor projects. Supports all ribbon item types (Button, Checkbox, DropDown, SplitButton, ComboBox, ColorPicker, GroupButton, Template), file menu operations, gallery items, contextual tabs, backstage view, keyboard navigation with KeyTips, events, theming, and accessibility features.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 13.7 KB |
| references/accessibility.md | markdown | 13.1 KB |
| references/backstage.md | markdown | 9.0 KB |
| references/contextual-tabs.md | markdown | 9.3 KB |
| references/customization.md | markdown | 12.4 KB |
| references/events.md | markdown | 12.2 KB |
| references/file-menu.md | markdown | 11.0 KB |
| references/gallery.md | markdown | 8.2 KB |
| references/getting-started.md | markdown | 6.7 KB |
| references/keytips.md | markdown | 10.9 KB |
| references/ribbon-items-advanced.md | markdown | 17.9 KB |
| references/ribbon-items-basic.md | markdown | 19.2 KB |
| references/ribbon-structure.md | markdown | 13.5 KB |
references/file-menu.md
View on GitHub# File Menu Configuration
Implement Office-style file menu for common file operations (New, Open, Save, Print).
## Enabling File Menu
Show file menu by setting `Visible="true"`:
```razor
@using Syncfusion.Blazor.Ribbon
@using Syncfusion.Blazor.Navigations
<SfRibbon>
<RibbonFileMenuSettings Visible="true" MenuItems="@fileMenuItems">
</RibbonFileMenuSettings>
<RibbonTabs>
<!-- Ribbon tabs -->
</RibbonTabs>
</SfRibbon>
@code {
private List<MenuItem> fileMenuItems = new List<MenuItem>()
{
new MenuItem { Text = "New", IconCss = "e-icons e-file-new", Id = "new" },
new MenuItem { Text = "Open", IconCss = "e-icons e-folder-open", Id = "open" },
new MenuItem { Text = "Save", IconCss = "e-icons e-save", Id = "save" },
new MenuItem { Text = "Save As", IconCss = "e-icons e-save", Id = "saveas" },
new MenuItem { Text = "Print", IconCss = "e-icons e-print", Id = "print" },
new MenuItem { Text = "Exit", IconCss = "e-icons e-exit", Id = "exit" }
};
}
```
## Adding Menu Items
Simple menu items with text and icons:
```razor
<RibbonFileMenuSettings Visible="true" MenuItems="@fileMenuItems">
</RibbonFileMenuSettings>
@code {
private List<MenuItem> fileMenuItems = new List<MenuItem>()
{
new MenuItem { Text = "New", IconCss = "e-icons e-file-new", Id = "new" },
new MenuItem { Text = "Open", IconCss = "e-icons e-folder-open", Id = "open" },
new MenuItem { Text = "Recent", IconCss = "e-icons e-clock", Id = "recent" },
new MenuItem { Text = "Save", IconCss = "e-icons e-save", Id = "save" }
};
}
```
## Nested Submenus
Create multi-level menu hierarchy:
```razor
<RibbonFileMenuSettings Visible="true" MenuItems="@fileMenuItems">
</RibbonFileMenuSettings>
@code {
private List<MenuItem> fileMenuItems = new List<MenuItem>()
{
new MenuItem { Text = "New", IconCss = "e-icons e-file-new", Id = "new" },
new MenuItem { Text = "Open", IconCss = "e-icons e-folder-open", Id = "open" },
new MenuItem { Text = "Save", IconCss = "e-icons e-save", Id = "save" },
new MenuItem {
Text = "Save As",
IconCss = "e-icons e-save",
Id = "saveas",
Items = new List<MenuItem>()
{
new MenuItem { Text = "Microsoft Word (.docx)", IconCss = "sf-icon-word", Id = "word" },
new MenuItem { Text = "Word 97-2003 (.doc)", IconCss = "sf-icon-word", Id = "word97" },
new MenuItem { Text = "PDF Document (.pdf)", IconCss = "e-icons e-export-pdf", Id = "pdf" },
new MenuItem { Text = "Plain Text (.txt)", IconCss = "e-icons e-file-text", Id = "txt" }
}
},
new MenuItem { Text = "Print", IconCss = "e-icons e-print", Id = "print" }
};
}
```
## Submenu Behavior
### Open Submenu on Hover (Default)
Submenu opens when hovering over parent item:
```razor
<RibbonFileMenuSettings Visible="true"
MenuItems="@fileMenuItems"
ShowItemOnClick="false">
</RibbonFileMenuSettings>
```
### Open Submenu on Click
Change to click-based submenu opening:
```razor
<RibbonFileMenuSettings Visible="true"
MenuItems="@fileMenuItems"
ShowItemOnClick="true">
</RibbonFileMenuSettings>
@code {
private List<MenuItem> fileMenuItems = new List<MenuItem>()
{
new MenuItem { Text = "Save As", IconCss = "e-icons e-save", Id = "saveas",
Items = new List<MenuItem>()
{
new MenuItem { Text = "Microsoft Word (.docx)", Id = "word" },
new MenuItem { Text = "PDF Document (.pdf)", Id = "pdf" }
}
}
};
}
```
## Custom Header Text
Change "File" to custom text:
```razor
<RibbonFileMenuSettings Text="Help" Visible="true" MenuItems="@helpMenuItems">
</RibbonFileMenuSettings>
@code {
private List<MenuItem> helpMenuItems = new List<MenuItem>()
{
new MenuItem { Text = "About", IconCss = "e-icons e-info" },
new MenuItem { Text = "Documentation", IconCss = "e-icons e-help" },
new MenuItem { Text = "Contact Support", IconCss = "e-icons e-email" }
};
}
```
## File Menu Events
### FileMenuOpening / FileMenuClosing
Triggered before menu state changes:
```razor
<RibbonFileMenuSettings Visible="true"
MenuItems="@fileMenuItems"
FileMenuOpening="@OnMenuOpening"
FileMenuClosing="@OnMenuClosing"
FileMenuOpened="@OnMenuOpened"
FileMenuClosed="@OnMenuClosed"
FileMenuItemRendering="@OnItemRender"
ItemSelecting="@OnItemSelect">
</RibbonFileMenuSettings>
@code {
private void OnMenuOpening(FileMenuOpenEventArgs args)
{
Console.WriteLine("File menu opening");
}
private void OnMenuClosing(FileMenuCloseEventArgs args)
{
Console.WriteLine("File menu closing");
}
private void OnMenuOpened(FileMenuOpenedEventArgs args)
{
Console.WriteLine("File menu opened");
}
private void OnMenuClosed(FileMenuClosedEventArgs args)
{
Console.WriteLine("File menu closed");
}
private void OnItemRender(FileMenuItemRenderEventArgs args)
{
Console.WriteLine($"Rendering item: {args.Item.Text}");
}
private void OnItemSelect(FileMenuItemSelectEventArgs args)
{
Console.WriteLine($"Item selected: {args.Item.Text}");
}
}
```
## Complete Example with Actions
Functional file menu with item selection handling:
```razor
@page "/file-menu-demo"
@using Syncfusion.Blazor.Ribbon
@using Syncfusion.Blazor.SplitButtons
@using Syncfusion.Blazor.Navigations
<h2>Document Editor with File Menu</h2>
<div style="margin-bottom: 20px;">
<p>Last Action: @lastAction</p>
</div>
<SfRibbon>
<RibbonFileMenuSettings Visible="true"
MenuItems="@fileMenuItems"
ShowItemOnClick="true"
ItemSelecting="@OnFileMenuItemSelect">
</RibbonFileMenuSettings>
<RibbonTabs>
<RibbonTab HeaderText="Home">
<RibbonGroups>
<RibbonGroup HeaderText="Clipboard">
<RibbonCollections>
<RibbonCollection>
<RibbonItems>
<RibbonItem Type="RibbonItemType.Button">
<RibbonButtonSettings Content="Paste" IconCss="e-icons e-paste">
</RibbonButtonSettings>
</RibbonItem>
</RibbonItems>
</RibbonCollection>
</RibbonCollections>
</RibbonGroup>
</RibbonGroups>
</RibbonTab>
</RibbonTabs>
</SfRibbon>
@code {
private string lastAction = "None";
private List<MenuItem> fileMenuItems = new List<MenuItem>()
{
new MenuItem { Text = "New", IconCss = "e-icons e-file-new", Id = "new" },
new MenuItem { Text = "Open", IconCss = "e-icons e-folder-open", Id = "open" },
new MenuItem { Text = "Recent", IconCss = "e-icons e-clock", Id = "recent",
Items = new List<MenuItem>()
{
new MenuItem { Text = "Document1.docx", Id = "doc1" },
new MenuItem { Text = "Document2.docx", Id = "doc2" },
new MenuItem { Text = "Document3.docx", Id = "doc3" }
}
},
new MenuItem { Text = "Save", IconCss = "e-icons e-save", Id = "save" },
new MenuItem {
Text = "Save As",
IconCss = "e-icons e-save",
Id = "saveas",
Items = new List<MenuItem>()
{
new MenuItem { Text = "Microsoft Word (.docx)", IconCss = "sf-icon-word", Id = "word" },
new MenuItem { Text = "Word 97-2003 (.doc)", IconCss = "sf-icon-word", Id = "word97" },
new MenuItem { Text = "PDF Document (.pdf)", IconCss = "e-icons e-export-pdf", Id = "pdf" },
new MenuItem { Text = "Plain Text (.txt)", IconCss = "e-icons e-file-text", Id = "txt" }
}
},
new MenuItem { Text = "Print", IconCss = "e-icons e-print", Id = "print" },
new MenuItem { Text = "Exit", IconCss = "e-icons e-exit", Id = "exit" }
};
private void OnFileMenuItemSelect(FileMenuItemSelectEventArgs args)
{
string itemId = args.Item.Id;
lastAction = itemId switch
{
"new" => "Creating new document",
"open" => "Opening document",
"recent" => "Opening recent document",
"save" => "Saving document",
"saveas" => "Save As dialog",
"word" => "Saving as .docx",
"pdf" => "Saving as PDF",
"print" => "Printing document",
"exit" => "Exiting application",
_ => $"Selected: {args.Item.Text}"
};
Console.WriteLine($"File menu action: {lastAction}");
}
}
```
## Recent Documents Pattern
Common pattern for recent file list:
```razor
@code {
private List<MenuItem> BuildRecentDocuments()
{
var recentDocs = new List<MenuItem>()
{
new MenuItem { Text = "Recent", IconCss = "e-icons e-clock", Id = "recent",
Items = new List<MenuItem>()
}
};
// Add recent documents dynamically
var documents = new[] { "Report_2026.docx", "Proposal_Final.docx", "Budget_Q1.xlsx" };
foreach (var doc in documents)
{
recentDocs[0].Items.Add(new MenuItem { Text = doc, Id = doc.ToLower() });
}
return recentDocs;
}
}
```
## Icons
Common file menu icons:
- `e-icons e-file-new` - New document
- `e-icons e-folder-open` - Open
- `e-icons e-save` - Save
- `e-icons e-print` - Print
- `e-icons e-clock` - Recent
- `e-icons e-exit` - Exit
- `e-icons e-export-pdf` - PDF
- `sf-icon-word` - Word document
- `e-icons e-help` - Help
## Best Practices
### 1. Logical Menu Organization
```
File Menu
├── New
├── Open
├── Recent → [Document list]
├── Save
├── Save As → [Format options]
├── Print
└── Exit
```
### 2. Icon Consistency
Use recognizable icons for common operations.
### 3. Keyboard Shortcuts
Consider adding keyboard shortcut hints in menu:
```razor
new MenuItem { Text = "Save (Ctrl+S)", IconCss = "e-icons e-save", Id = "save" }
```
### 4. Separator Items
```razor
new MenuItem { Separator = true }, // Visual separator
```
### 5. Disabled Menu Items
```razor
new MenuItem { Text = "Save", IconCss = "e-icons e-save", Disabled = true }
```
## Troubleshooting
**Menu not appearing:**
- Verify `Visible="true"` is set
- Check `MenuItems` collection has items
**Submenu not opening:**
- Confirm `ShowItemOnClick` matches your UX preference
- Verify submenu items are in `Items` collection
**Events not firing:**
- Confirm event handler signature matches (e.g., `FileMenuItemSelectEventArgs`)
- Check event handler is bound with `@`
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |