syncfusion-maui-toolkit-button

---
name: syncfusion-maui-toolkit-button
description: Implements and customize Syncfusion .NET MAUI Button (SfButton) control. Use when working with MAUI buttons, SfButton implementation, button customization, or visual states. Covers button icons, background images, RTL support, custom button views, button styling, events, and checkable buttons.
metadata:
  author: "Syncfusion Inc"
  version: "1.0.0"
---

# Implementing .NET MAUI Button

A comprehensive skill for implementing and customizing the Syncfusion .NET MAUI Button (SfButton) control. The SfButton provides rich customization options including icons, background images, visual states, corner radius, and custom content support.

## When to Use This Skill

Use this skill when you need to:
- Install and set up SfButton in a .NET MAUI project
- Create basic or customized buttons with text and icons
- Implement visual states (normal, hovered, pressed, checked, disabled)
- Add background images or custom content to buttons
- Handle button click events
- Create toggle/checkable buttons
- Apply RTL (right-to-left) support
- Customize button appearance (colors, fonts, borders, padding)
- Troubleshoot button-related issues

## Component Overview

The Syncfusion .NET MAUI Button (SfButton) is a custom button control that extends the standard MAUI button with advanced UI customization capabilities:

**Key Features:**
- **Flexible styling:** Outline, flat, circle, or icon button types
- **Rich content:** Icons, background images, and custom views
- **Visual states:** Built-in support for hover, press, checked, and disabled states
- **Accessibility:** RTL support and keyboard navigation
- **Easy integration:** Simple XAML or C# implementation

## Documentation and Navigation Guide

### Getting Started
📄 **Read:** [references/getting-started.md](references/getting-started.md)

When to read: Installation, initial setup, first-time implementation
- NuGet package installation (`Syncfusion.Maui.Toolkit`)
- Handler registration in `MauiProgram.cs`
- Basic button implementation in XAML and C#
- Adding button icons with `ImageSource` and `ShowIcon`
- Setting background images with `BackgroundImageSource`
- Minimal working examples

### Customization and Styling
📄 **Read:** [references/customization.md](references/customization.md)

When to read: Appearance customization, styling buttons, layout control
- Text customization (color, size, font, alignment)
- Background color and border styling
- Corner radius and padding adjustments
- Size control (width, height)
- Image width and positioning
- Alignment options (horizontal, vertical)
- Complete styling examples

### Visual States
📄 **Read:** [references/visual-states.md](references/visual-states.md)

When to read: State-based styling, hover effects, toggle buttons, interactive feedback
- Visual state overview (Normal, Hovered, Pressed, Checked, Disabled)
- Implementing VisualStateManager
- Creating checkable/toggle buttons with `IsCheckable`
- Customizing appearance for each state
- State transition handling
- Complete state management examples

### Advanced Features
📄 **Read:** [references/advanced-features.md](references/advanced-features.md)

When to read: RTL support, modern effects, custom content, events, migration
- Right-to-Left (RTL) language support
- Adding custom content views inside buttons
- Click event handling (`Clicked` event)
- Advanced scenarios and combinations
- Migration from older versions

### Troubleshooting
📄 **Read:** [references/troubleshooting.md](references/troubleshooting.md)

When to read: Issues, errors, unexpected behavior, best practices
- Common problems and solutions
- Handler registration errors
- Image loading issues
- Layout and sizing problems
- Visual state not updating
- Platform-specific considerations