Skip to content

Commit b62549f

Browse files
author
SivakumarVairamuthu
committed
Updated API Reference for new features.
1 parent 8ba5793 commit b62549f

File tree

12 files changed

+42
-38
lines changed

12 files changed

+42
-38
lines changed

maui-toolkit/Bottom-Sheet/BottomSheet-Customization.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ bottomSheet.AllowedState = BottomSheetAllowedState.HalfExpanded;
9292

9393
## Overlay tap to collapse
9494

95-
The `CollapseOnOverlayTap` property enables the bottom sheet to collapse when the user taps on the overlay (outside the sheet). This enhances user interaction by allowing easy dismissal of the sheet without fully closing it.
95+
The [CollapseOnOverlayTap](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.BottomSheet.SfBottomSheet.html#Syncfusion_Maui_Toolkit_BottomSheet_SfBottomSheet_CollapseOnOverlayTap) property enables the bottom sheet to collapse when the user taps on the overlay (outside the sheet). This enhances user interaction by allowing easy dismissal of the sheet without fully closing it.
9696

9797
{% tabs %}
9898
{% highlight xaml %}
@@ -112,6 +112,8 @@ bottomSheet.CollapseOnOverlayTap = true;
112112
{% endhighlight %}
113113
{% endtabs %}
114114

115+
![CollapseOnOverlay Gif](images/collapseOnOverlay.gif)
116+
115117
## Content Padding
116118
The [ContentPadding](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.BottomSheet.SfBottomSheet.html#Syncfusion_Maui_Toolkit_BottomSheet_SfBottomSheet_ContentPadding) property of the [BottomSheet](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.BottomSheet.SfBottomSheet.html) adds space around the content creating a gap between the bottom sheet content and the edges.
117119

@@ -377,7 +379,7 @@ SfBottomSheet bottomSheet = new SfBottomSheet
377379

378380
### Grabber area height
379381

380-
The `GrabberAreaHeight` feature in the [BottomSheet](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.BottomSheet.SfBottomSheet.html) control allows developers to adjust the height of the drag area, thus enhancing both usability and appearance.
382+
The [GrabberAreaHeight](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.BottomSheet.SfBottomSheet.html#Syncfusion_Maui_Toolkit_BottomSheet_SfBottomSheet_GrabberAreaHeight) feature in the [BottomSheet](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.BottomSheet.SfBottomSheet.html) control allows developers to adjust the height of the drag area, thus enhancing both usability and appearance.
381383

382384
{% tabs %}
383385
{% highlight xaml %}
379 KB
Loading

maui-toolkit/Otp-Input/Events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Events in the OTP Input control allow developers to respond effectively to user
1313

1414
## ValueChanged event
1515

16-
The OTP Input component triggers the `ValueChanged` event whenever the value of an input field changes. This is particularly useful for validating input in real-time or triggering further actions as user input is completed. The `OtpInputValueChangedEventArgs` provides details about the specific changes in value.
16+
The OTP Input component triggers the [ValueChanged](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_ValueChanged) event whenever the value of an input field changes. This is particularly useful for validating input in real-time or triggering further actions as user input is completed. The [OtpInputValueChangedEventArgs](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputValueChangedEventArgs.html) provides details about the specific changes in value.
1717

1818
{% tabs %}
1919
{% highlight xaml %}

maui-toolkit/Otp-Input/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 .NET MAUI OTP Input
1111

12-
This section provides a quick overview of how to get started with the `OTP Input` for .NET MAUI and a walk-through to configure the .NET MAUI OTP Input in a real-time scenario. Follow the steps below to add .NET MAUI OTP Input to your project.
12+
This section provides a quick overview of how to get started with the [OTP Input](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html) for .NET MAUI and a walk-through to configure the .NET MAUI OTP Input in a real-time scenario. Follow the steps below to add .NET MAUI OTP Input to your project.
1313

1414
{% tabcontents %}
1515
{% tabcontent Visual Studio %}
@@ -66,7 +66,7 @@ public static class MauiProgram
6666

6767
1. To initialize the control, import the `Syncfusion.Maui.Toolkit.OtpInput` namespace into your code.
6868

69-
2. Initialize `SfOtpInput.`
69+
2. Initialize [SfOtpInput.](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html)
7070

7171
{% tabs %}
7272
{% highlight xaml %}
@@ -139,7 +139,7 @@ public static class MauiProgram
139139

140140
1. To initialize the control, import the `Syncfusion.Maui.Toolkit.OtpInput` namespace into your code.
141141

142-
2. Initialize `SfOtpInput.`
142+
2. Initialize [SfOtpInput.](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html)
143143

144144
{% tabs %}
145145
{% highlight xaml %}
@@ -211,7 +211,7 @@ public static class MauiProgram
211211

212212
1. To initialize the control, import the `Syncfusion.Maui.Toolkit.OtpInput` namespace into your code.
213213

214-
2. Initialize `SfOtpInput.`
214+
2. Initialize [SfOtpInput.](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html)
215215

216216
{% tabs %}
217217
{% highlight xaml %}
@@ -231,7 +231,7 @@ SfOtpInput otpInput = new SfOtpInput();
231231

232232
## Value
233233

234-
You can specify the value of OTP Input by using the `Value` property.
234+
You can specify the value of OTP Input by using the [Value](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Value) property.
235235

236236
{% tabs %}
237237
{% highlight xaml %}

maui-toolkit/Otp-Input/Input-Types.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This section explains the various types of OTP (One-Time Password) input compone
1515

1616
### Number type
1717

18-
The `Type` property can be set to `Number`, prompting the input to handle numeric-only codes. This is ideal for scenarios demanding numeric OTP's. By default, the `Type` property is set to `Number`.
18+
The [Type](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Type) property can be set to [Number](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputType.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputType_Number), prompting the input to handle numeric-only codes. This is ideal for scenarios demanding numeric OTP's. By default, the `Type` property is set to `Number.`
1919

2020
{% tabs %}
2121
{% highlight xaml %}
@@ -38,7 +38,7 @@ SfOtpInput otpInput = new SfOtpInput()
3838

3939
### Text type
4040

41-
You can set the `Type` property to `Text` for inputs that may include both letters and numbers, suitable for alphanumeric OTP's.
41+
You can set the [Type](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Type) property to [Text](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputType.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputType_Text) for inputs that may include both letters and numbers, suitable for alphanumeric OTP's.
4242

4343
{% tabs %}
4444
{% highlight xaml %}
@@ -61,7 +61,7 @@ SfOtpInput otpInput = new SfOtpInput()
6161

6262
### Password type
6363

64-
You can set the `Type` property to `Password` to use this input type as password in the OTP Input.
64+
You can set the [Type]https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Type property to [Password](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputType.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputType_Password) to use this input type as password in the OTP Input.
6565

6666
{% tabs %}
6767
{% highlight xaml %}

maui-toolkit/Otp-Input/OtpInput-Customization.md

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

1010
# Customization in .NET MAUI OTP Input (SfOtpInput)
1111

12-
An `OTP Input` consists of multiple elements that can be customized to enhance both its appearance and functionality.
12+
An [OTP Input](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html) consists of multiple elements that can be customized to enhance both its appearance and functionality.
1313

1414
## Placeholder
1515

1616
The placeholder for the OTP Input specifies the text that appears as a hint until the user enters a value.
1717

18-
Set the placeholder text using the `Placeholder` property. When a single character is assigned, each input field will show the same character.
18+
Set the placeholder text using the [Placeholder](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Placeholder) property. When a single character is assigned, each input field will show the same character.
1919

2020
{% tabs %}
2121
{% highlight xaml %}
@@ -57,7 +57,7 @@ SfOtpInput otpInput = new SfOtpInput()
5757

5858
### PlaceholderColor
5959

60-
The color of placeholder text can be changed using the `PlaceholderColor` property.
60+
The color of placeholder text can be changed using the [PlaceholderColor](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_PlaceholderColor) property.
6161

6262
{% tabs %}
6363
{% highlight xaml %}
@@ -80,7 +80,7 @@ SfOtpInput otpInput = new SfOtpInput()
8080

8181
## Separator
8282

83-
The `Separator` property defines a character or symbol used to separate each input field, visually distinguishing inputs.
83+
The [Separator](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Separator) property defines a character or symbol used to separate each input field, visually distinguishing inputs.
8484

8585
{% tabs %}
8686
{% highlight xaml %}
@@ -102,7 +102,7 @@ SfOtpInput otpInput = new SfOtpInput()
102102

103103
## Setting input length
104104

105-
You can specify the number of input fields to match the desired OTP code length by using the `Length` property. The default value is `4`.
105+
You can specify the number of input fields to match the desired OTP code length by using the [Length](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Length) property. The default value is `4`.
106106

107107
{% tabs %}
108108
{% highlight xaml %}
@@ -124,7 +124,7 @@ SfOtpInput otpInput = new SfOtpInput()
124124

125125
## Input background
126126

127-
You can set the `InputBackground` property to any color to customize the appearance of the input fields. The `InputBackground` property applies only when `StylingMode` is set to `Filled.`
127+
You can set the [InputBackground](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_InputBackground) property to any color to customize the appearance of the input fields. The `InputBackground` property applies only when [StylingMode](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_StylingMode) is set to [Filled.](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputStyle.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputStyle_Filled)
128128

129129
{% tabs %}
130130
{% highlight xaml %}
@@ -147,7 +147,7 @@ SfOtpInput otpInput = new SfOtpInput()
147147

148148
## Stroke
149149

150-
You can set the `Stroke` property to any color to customize the border appearance of the input fields.
150+
You can set the [Stroke](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Stroke) property to any color to customize the border appearance of the input fields.
151151

152152
{% tabs %}
153153
{% highlight xaml %}
@@ -169,7 +169,7 @@ SfOtpInput otpInput = new SfOtpInput()
169169

170170
## Text color
171171

172-
You can set the `TextColor` property to any color to customize the text appearance of the input fields.
172+
You can set the [TextColor](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_TextColor) property to any color to customize the text appearance of the input fields.
173173

174174
{% tabs %}
175175
{% highlight xaml %}
@@ -191,7 +191,7 @@ SfOtpInput otpInput = new SfOtpInput()
191191

192192
## Mask character
193193

194-
You can set the `MaskCharacter` property to any character to define how the masked input is displayed, enhancing security by obscuring sensitive information. The `MaskCharacter` property applies only when `Type` is set to `Password.`
194+
You can set the [MaskCharacter](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_MaskCharacter) property to any character to define how the masked input is displayed, enhancing security by obscuring sensitive information. The `MaskCharacter` property applies only when [Type](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Type) is set to [Password.](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputType.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputType_Password)
195195

196196
{% tabs %}
197197
{% highlight xaml %}
@@ -214,11 +214,11 @@ SfOtpInput otpInput = new SfOtpInput()
214214

215215
## Input state
216216

217-
The `InputState` property in the OTP Input allows you to visually represent the validation status of the input fields.
217+
The [InputState](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_InputState) property in the OTP Input allows you to visually represent the validation status of the input fields.
218218

219219
### Success
220220

221-
The `InputState` can be set to `Success` to indicate that the input is correct. When the `InputState` is set to `Success,` the stroke of the OTP Input turns green.
221+
The [InputState](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_InputState) can be set to [Success](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputState.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputState_Success) to indicate that the input is correct. When the `InputState` is set to `Success,` the stroke of the OTP Input turns green.
222222

223223
{% tabs %}
224224
{% highlight xaml %}
@@ -240,7 +240,7 @@ SfOtpInput otpInput = new SfOtpInput()
240240

241241
### Warning
242242

243-
The `InputState` can be set to `Warning` to indicate a potential issue with the input, prompting the user to correct it. The stroke of the OTP Input turns orange-brown when `InputState` is set to `Warning.`
243+
The [InputState](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_InputState) can be set to [Warning](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputState.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputState_Warning) to indicate a potential issue with the input, prompting the user to correct it. The stroke of the OTP Input turns orange-brown when `InputState` is set to `Warning.`
244244

245245
{% tabs %}
246246
{% highlight xaml %}
@@ -262,7 +262,7 @@ SfOtpInput otpInput = new SfOtpInput()
262262

263263
### Error
264264

265-
The `InputState` can be set to `Error` to indicate that the input is invalid or requires correction. The stroke of OTP Input turns red when `InputState` is set to `Error.`
265+
The [InputState](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_InputState) can be set to [Error](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputState.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputState_Error) to indicate that the input is invalid or requires correction. The stroke of OTP Input turns red when `InputState` is set to `Error.`
266266

267267
{% tabs %}
268268
{% highlight xaml %}

maui-toolkit/Otp-Input/Overview.md

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

1010
# .NET MAUI OTP Input (SfOtpInput) Overview
1111

12-
An `OTP Input` is a user interface component commonly used in applications that require one-time password (OTP) verification for authentication. This simplify and streamline the process of entering OTP codes received via SMS, email, or other communication channels.
12+
An [OTP Input](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html) is a user interface component commonly used in applications that require one-time password (OTP) verification for authentication. This simplify and streamline the process of entering OTP codes received via SMS, email, or other communication channels.
1313

1414
![.NET MAUI OTP Input.](images/overview.png)
1515

1616
## Key Features
1717

18-
* `Length` - Customize the number of input fields to match the desired OTP code length.
18+
* [Length](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Length) - Customize the number of input fields to match the desired OTP code length.
1919

20-
* `StylingMode` - Supports different styling modes : Outlined, Filled, and Underlined.
20+
* [StylingMode](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_StylingMode) - Supports different styling modes : Outlined, Filled, and Underlined.
2121

22-
* `Type` - Supports different input types : Number, Text, and Password.
22+
* [Type](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Type) - Supports different input types : Number, Text, and Password.
2323

24-
* `Separator` – Specifies the character or symbol used to separate each input field.
24+
* [Separator](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.SfOtpInput.html#Syncfusion_Maui_Toolkit_OtpInput_SfOtpInput_Separator) – Specifies the character or symbol used to separate each input field.

maui-toolkit/Otp-Input/Styling-Modes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Styling modes specify the visual style variants for input fields in the OTP Inpu
1414

1515
## Outline mode
1616

17-
You can customize the appearance of input fields with a border around them by setting the `StylingMode` property to `Outlined.` This is the default styling mode for the OTP Input component.
17+
You can customize the appearance of input fields with a border around them by setting the [StylingMode](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputStyle.html) property to [Outlined.](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputStyle.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputStyle_Outlined) This is the default styling mode for the OTP Input component.
1818

1919
{% tabs %}
2020
{% highlight xaml %}
@@ -36,7 +36,7 @@ SfOtpInput otpInput = new SfOtpInput()
3636

3737
## Filled mode
3838

39-
You can customize the appearance of input fields by filling them with color by setting the `StylingMode` property to `Filled.`
39+
You can customize the appearance of input fields by filling them with color by setting the [StylingMode](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputStyle.html) property to [Filled.](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputStyle.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputStyle_Filled)
4040

4141
{% tabs %}
4242
{% highlight xaml %}
@@ -58,7 +58,7 @@ SfOtpInput otpInput = new SfOtpInput()
5858

5959
## Underline mode
6060

61-
You can customize the appearance of input fields with an underline by setting the `StylingMode` property to `Underlined.`
61+
You can customize the appearance of input fields with an underline by setting the [StylingMode](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputStyle.html) property to [Underlined.](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.OtpInput.OtpInputStyle.html#Syncfusion_Maui_Toolkit_OtpInput_OtpInputStyle_Underlined)
6262

6363
{% tabs %}
6464
{% highlight xaml %}

0 commit comments

Comments
 (0)