Skip to content

959291 - Tools Controls UG documentation Review changes by AI #3299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions MAUI/Button/Customization.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
layout: post
title: Customization in .NET MAUI Button control | Syncfusion®
description: Learn here all about Customization support in Syncfusion® .NET MAUI Button (SfButton) control and more.
title: "Customization in .NET MAUI Button Control | Syncfusion®"
description: "Learn about customization support in the Syncfusion® .NET MAUI Button (SfButton) control."
platform: maui
control: SfButton
documentation: ug
---

# Customization in .NET MAUI Button (SfButton)

The [.NET MAUI Button](https://www.syncfusion.com/maui-controls/maui-button) control supports to customize the border color, image width, corner radius, background color, and more. The button control can be customized using the following properties:
The [.NET MAUI Button](https://www.syncfusion.com/maui-controls/maui-button) control allows you to customize aspects such as border color, image width, corner radius, background color, and more. The following properties are available for button customization:

## Text Customization

The text inside the button can be customized by its text color, font size, font attributes, font family and text alignment.
Customize the text inside the button using properties for text color, font size, font attributes, font family, and text alignment.

### TextColor

The [`TextColor`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Core.ButtonBase.html#Syncfusion_Maui_Core_ButtonBase_TextColor) property is used to customize the color of text in [`SfButton`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html).
Use the [`TextColor`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Core.ButtonBase.html#Syncfusion_Maui_Core_ButtonBase_TextColor) property to customize the text color in [`SfButton`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html).

{% tabs %}
{% highlight xaml %}
Expand Down
8 changes: 4 additions & 4 deletions MAUI/Button/Events.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: post
title: Event in .NET MAUI Button Control | Syncfusion®
description: Learn here about Event support in the Syncfusion® .NET MAUI Button (SfButton) control, its elements and more.
title: "Event in .NET MAUI Button Control | Syncfusion®"
description: "Learn about event support in the Syncfusion® .NET MAUI Button (SfButton) control, its elements, and more."
platform: maui
control: SfButton
documentation: ug
Expand All @@ -10,9 +10,9 @@ documentation: ug

# Event in .NET MAUI Button (SfButton)

## Clicked event
## Clicked Event

The click event occurs when the [`SfButton`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html) is clicked. The event argument is of type `EventArgs`.
The Clicked event is triggered when the [`SfButton`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html) is clicked. The event argument is of type `EventArgs`.

{% tabs %}
{% highlight xaml %}
Expand Down
9 changes: 5 additions & 4 deletions MAUI/Button/Getting-Started.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
layout: post
title: Getting Started with .NET MAUI Button | Syncfusion®
description: Learn here about getting started with the Syncfusion® .NET MAUI Button (SfButton) control, its elements and more.
title: "Getting Started with .NET MAUI Button | Syncfusion®"
description: "Learn how to get started with the Syncfusion® .NET MAUI Button (SfButton) control, its elements, and more."
platform: MAUI
control: SfButton
documentation: ug
---

> **Notice**: After **Volume 1 2025 (Mid of March 2025)**, updates, bug fixes, and feature enhancements for this control will no longer be available in the Syncfusion<sup>®</sup> package. Please switch to the **Syncfusion<sup>®</sup> Toolkit for .NET MAUI** for continued support. For a smooth transition refer this [migration document](https://help.syncfusion.com/maui-toolkit/migration).
> **Notice**: After **Volume 1 2025 (Mid March 2025)**, updates, bug fixes, and feature enhancements for this control will no longer be available in the Syncfusion<sup>®</sup> package. Please switch to the **Syncfusion<sup>®</sup> Toolkit for .NET MAUI** for continued support. For a smooth transition, refer to this [migration document](https://help.syncfusion.com/maui-toolkit/migration).

# Getting Started with .NET MAUI Button

Expand Down Expand Up @@ -42,7 +42,7 @@ Before proceeding, ensure the following are in place:

## Step 3: Register the Handler

[Syncfusion.Maui.Core](https://www.nuget.org/packages/Syncfusion.Maui.Core) nuget is a dependent package for all Syncfusion<sup>®</sup> controls of .NET MAUI. In the **MauiProgram.cs file**, register the handler for Syncfusion<sup>®</sup> core.
The [Syncfusion.Maui.Core](https://www.nuget.org/packages/Syncfusion.Maui.Core) NuGet package is a dependency for all Syncfusion<sup>®</sup> controls in .NET MAUI. In the **MauiProgram.cs** file, register the handler for Syncfusion<sup>®</sup> core.

{% highlight c# hl_lines="6 17" %}
using Microsoft.Maui;
Expand Down Expand Up @@ -271,3 +271,4 @@ button.WidthRequest = 150;
Find the complete getting started sample of the .NET MAUI Button from this [link.](https://github.com/SyncfusionExamples/maui-button-samples)

N> You can refer to our [.NET MAUI Button](https://www.syncfusion.com/maui-controls/maui-button) feature tour page for its groundbreaking feature representations. You can also explore our [.NET MAUI Button Example](https://github.com/syncfusion/maui-demos/tree/master/MAUI/Buttons) that shows you how to render the Button in .NET MAUI.

7 changes: 4 additions & 3 deletions MAUI/Button/Migration.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
layout: post
title: Migrating from Xamarin to .NET MAUI Button | Syncfusion®
description: Learn about Migrating from Syncfusion® Xamarin Button to the Syncfusion® .NET MAUI Button control and more here.
title: "Migrating from Xamarin to .NET MAUI Button | Syncfusion®"
description: "Learn about migrating from the Syncfusion® Xamarin Button to the Syncfusion® .NET MAUI Button control."
platform: maui
control: SfButton
documentation: ug
---

# Migrating from Xamarin SfButton to .NET MAUI SfButton

To migrate easier from Xamarin SfButton to [.NET MAUI SfButton](https://www.syncfusion.com/maui-controls/maui-button), we kept most of the APIs from Xamarin SfButton in MAUI SfButton. However, to maintain the consistency of the API naming in MAUI SfButton, we renamed some of the APIs. The APIs changed in MAUI SfButton from Xamarin SfButton are detailed as follows:
To facilitate an easier migration from Xamarin SfButton to the [.NET MAUI SfButton](https://www.syncfusion.com/maui-controls/maui-button), most APIs from the Xamarin SfButton have been retained in the MAUI version. However, some APIs have been renamed to maintain consistency in naming within the MAUI SfButton. The changes in API names between MAUI and Xamarin SfButton are detailed below:

## Namespaces

Expand Down Expand Up @@ -50,3 +50,4 @@ To migrate easier from Xamarin SfButton to [.NET MAUI SfButton](https://www.sync
## Known Issues

The gradient colors used as a background are not functioning as expected because of a framework-level issue. This issue is specifically related to the incorrect rendering of gradient color on iOS and macOS when clipping a view. Refer to this [link](https://github.com/dotnet/maui/issues/18671) for more details.

17 changes: 9 additions & 8 deletions MAUI/Button/Overview.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
---
layout: post
title: About .NET MAUI Control | Syncfusion®
description: Learn here about introduction of the Syncfusion® .NET MAUI Button (SfButton) control, its elements and more.
title: "About .NET MAUI Control | Syncfusion®"
description: "Learn about the introduction of the Syncfusion® .NET MAUI Button (SfButton) control, its elements, and more."
platform: maui
control: SfButton
documentation: ug
---

> **Notice**: After **Volume 1 2025 (Mid of March 2025)**, updates, bug fixes, and feature enhancements for this control will no longer be available in the Syncfusion<sup>®</sup> package. Please switch to the **Syncfusion<sup>®</sup> Toolkit for .NET MAUI** for continued support. For a smooth transition refer this [migration document](https://help.syncfusion.com/maui-toolkit/migration).
> **Notice**: After **Volume 1 2025 (Mid-March 2025)**, updates, bug fixes, and feature enhancements for this control will no longer be available in the Syncfusion<sup>®</sup> package. Please switch to the **Syncfusion<sup>®</sup> Toolkit for .NET MAUI** for continued support. For a smooth transition, please refer to this [migration document](https://help.syncfusion.com/maui-toolkit/migration).

# .NET MAUI Button (SfButton) Overview

The .NET MAUI Button is a custom button control with UI customization. Set icons, background images, and corner edge radii and customize the appearance for different visual states using the visual state manager.
The .NET MAUI Button is a customizable button control that allows for UI customization. You can set icons, background images, and corner edge radii, and customize the appearance for different visual states using the Visual State Manager.

## Key features
## Key Features

* Easily customize a button as an outline, flat, circle, or icon button.
* Display an image as the background for the control.
* Display custom content in the button control.
- Easily customize the button to be an outline, flat, circle, or icon button.
- Display an image as the background for the control.
- Display custom content within the button control.

![Overview image of SfButton](Images/overview/Overview.png)

12 changes: 8 additions & 4 deletions MAUI/Button/Right-To-Left.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
---
layout: post
title: Right To Left in .NET MAUI Button Control | Syncfusion®
description: Learn about the comprehensive support for right-to-left (RTL) directionality within the Syncfusion® .NET MAUI Button, also known as the SfButton control.
title: "Right-To-Left in .NET MAUI Button Control | Syncfusion®"
description: "Learn about comprehensive support for right-to-left (RTL) directionality within the Syncfusion® .NET MAUI Button, also known as the SfButton control."
platform: maui
control: SfButton
documentation: ug
---

# Right To Left in .NET MAUI Button (SfButton)
# Right-To-Left in .NET MAUI Button (SfButton)

[SfButton](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html) supports changing the layout direction of the control in the right-to-left direction by setting the [FlowDirection](https://learn.microsoft.com/en-us/dotnet/api/microsoft.maui.controls.device.flowdirection?view=net-maui-7.0) to `RightToLeft` or by changing the device language.
The [SfButton](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html) control supports layout direction changes to right-to-left by setting the [FlowDirection](https://learn.microsoft.com/en-us/dotnet/api/microsoft.maui.controls.device.flowdirection?view=net-maui-7.0) property to `RightToLeft` or by changing the device language to an RTL language.

## Example

Below is an example of how you can enable right-to-left directionality in the SfButton:

{% tabs %}
{% highlight xaml %}
Expand Down
12 changes: 8 additions & 4 deletions MAUI/Button/Visual-States.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: post
title: Visual states in .NET MAUI Button Control | Syncfusion®
description: Learn about visual states support in the Syncfusion® .NET MAUI Button (SfButton) control, its elements, and more.
title: "Visual States in .NET MAUI Button Control | Syncfusion®"
description: "Learn about visual states support in the Syncfusion® .NET MAUI Button (SfButton) control, its elements, and more."
platform: maui
control: SfButton
documentation: ug
Expand All @@ -10,15 +10,19 @@ documentation: ug

# Visual States in .NET MAUI Button (SfButton)

The visual of the Button can be customized using `VisualStates`. The [SfButton](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html) control contains the following five visual states:
The visual appearance of the SfButton can be customized using `VisualStates`. The [SfButton](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html) control supports the following five visual states:

* Normal
* Hovered
* Pressed
* Checked
* Disabled

N> The visual states [Checked](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html#Syncfusion_Maui_Buttons_SfButton_IsChecked) and Unchecked are only updated when enabling the [IsCheckable](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html#Syncfusion_Maui_Buttons_SfButton_IsCheckable) property in the SfButton.
> **Note:** The visual states [Checked](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html#Syncfusion_Maui_Buttons_SfButton_IsChecked) and Unchecked are only activated when the [IsCheckable](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html#Syncfusion_Maui_Buttons_SfButton_IsCheckable) property is enabled in the SfButton.

## Example

The following example demonstrates how to define visual states for the SfButton:

{% tabs %}
{% highlight xaml %}
Expand Down
10 changes: 5 additions & 5 deletions MAUI/Button/how-to/Add-the-custom-view-for-button.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
layout: post
title: How to Add the Custom View for Syncfusion® SfButton
description: Learn here about how to add the custom view for the Syncfusion® .NET MAUI Button (SfButton) control.
title: "How to Add a Custom View to the Syncfusion® SfButton"
description: "Learn how to add a custom view for the Syncfusion® .NET MAUI Button (SfButton) control."
platform: maui
control: Sfbutton
control: SfButton
documentation: ug
---

# Add the custom view for button
# Add a Custom View to the Button

You can customize the appearance of the button by adding your custom view in the [`Content`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html#Syncfusion_Maui_Buttons_SfButton_Content) property. The following code sample demonstrates how to apply the busy indicator control as a custom view for a button.
Customize the appearance of the button by adding a custom view to the [`Content`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Buttons.SfButton.html#Syncfusion_Maui_Buttons_SfButton_Content) property. The following code sample demonstrates how to apply a busy indicator control as a custom view for a button.

{% tabs %}
{% highlight xaml %}
Expand Down
21 changes: 13 additions & 8 deletions MAUI/Carousel-View/Animation.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
---
layout : post
title: Animation in .NET MAUI Carousel View control | Syncfusion®
description: Learn here all about Animation support in Syncfusion® .NET MAUI Carousel View (SfCarousel) control and more.
platform : maui
control : Carousel
documentation : ug
layout: post
title: "Animation in .NET MAUI CarouselView Control | Syncfusion®"
description: "Learn about animation support in the Syncfusion® .NET MAUI CarouselView (SfCarousel) control."
platform: maui
control: Carousel
documentation: ug
---

# Animation in .NET MAUI Carousel View (SfCarousel)
# Animation in .NET MAUI CarouselView (SfCarousel)

The [Duration](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Carousel.SfCarousel.html#Syncfusion_Maui_Carousel_SfCarousel_Duration) property of the [SfCarousel](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Carousel.SfCarousel.html) control specifies the time taken to move an item to the selected item position in the Default mode. The duration is specified in milliseconds. The default value is 600 ms.
The [Duration](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Carousel.SfCarousel.html#Syncfusion_Maui_Carousel_SfCarousel_Duration) property in the [SfCarousel](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Carousel.SfCarousel.html) control specifies the time taken for an item to transition to the selected item position in Default mode. The duration is specified in milliseconds, with a default value of 600 ms.

## Example

Here's how you can set the animation duration for the SfCarousel:

{% tabs %}

Expand All @@ -33,3 +37,4 @@ carousel.Duration = 1000;

{% endtabs %}


18 changes: 11 additions & 7 deletions MAUI/Carousel-View/Linear-Arrangement.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
---
layout : post
title: Linear Arrangement in .NET MAUI Carousel View control | Syncfusion®
description: Learn here all about Linear Arrangement support in Syncfusion® .NET MAUI Carousel View (SfCarousel) control and more.
platform : maui
control : Carousel
documentation : ug
layout: post
title: "Linear Arrangement in .NET MAUI Carousel View Control | Syncfusion®"
description: "Learn about Linear Arrangement support in the Syncfusion® .NET MAUI Carousel View (SfCarousel) control."
platform: maui
control: Carousel
documentation: ug
---

# Linear Arrangement in .NET MAUI Carousel View (SfCarousel)

The Carousel items can be populated in the view in a stacked linear layout by setting the [ViewMode](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Carousel.SfCarousel.html#Syncfusion_Maui_Carousel_SfCarousel_ViewMode) property to [Linear](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Core.Carousel.ViewMode.html#Syncfusion_Maui_Core_Carousel_ViewMode_Linear). The present option is [Default](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Core.Carousel.ViewMode.html#Syncfusion_Maui_Core_Carousel_ViewMode_Default).
Carousel items can be arranged in a linear stacked layout by setting the [ViewMode](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Carousel.SfCarousel.html#Syncfusion_Maui_Carousel_SfCarousel_ViewMode) property to [Linear](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Core.Carousel.ViewMode.html#Syncfusion_Maui_Core_Carousel_ViewMode_Linear). The default option is [Default](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Core.Carousel.ViewMode.html#Syncfusion_Maui_Core_Carousel_ViewMode_Default).

## Example

Here is how you can configure the Carousel in Linear ViewMode:

{% tabs %}

Expand Down
Loading