Skip to content

Commit 1f74568

Browse files
Merge pull request #6944 from syncfusion-content/BLAZ-983104-Textbox
Updated the UG Documentation for Textbox.
2 parents d39ab44 + 46a5d48 commit 1f74568

22 files changed

+222
-226
lines changed

blazor/textbox/accessibility.md

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

1010
# Accessibility in Blazor TextBox Component
1111

12-
The [Blazor TextBox](https://www.syncfusion.com/blazor-components/blazor-textbox) component followed the accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/) standards, and [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) that are commonly used to evaluate accessibility.
12+
The [Blazor TextBox](https://www.syncfusion.com/blazor-components/blazor-textbox) follows accessibility guidelines and standards commonly used to evaluate UI accessibility, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/), and [WAI‑ARIA](https://www.w3.org/TR/wai-aria/).
1313

1414
The accessibility compliance for the Blazor TextBox component is outlined below.
1515

1616
| Accessibility Criteria | Compatibility |
1717
| -- | -- |
18-
| [WCAG 2.2 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
19-
| [Section 508 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
20-
| [Screen Reader Support](../common/accessibility#screen-reader-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
21-
| [Right-To-Left Support](../common/accessibility#right-to-left-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
22-
| [Color Contrast](../common/accessibility#color-contrast) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
23-
| [Mobile Device Support](../common/accessibility#mobile-device-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
24-
| [Keyboard Navigation Support](../common/accessibility#keyboard-navigation-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
25-
| [Axe-core Accessibility Validation](../common/accessibility#ensuring-accessibility) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
18+
| [WCAG 2.2 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> |
19+
| [Section 508 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> |
20+
| [Screen Reader Support](../common/accessibility#screen-reader-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> |
21+
| [Right-To-Left Support](../common/accessibility#right-to-left-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> |
22+
| [Color Contrast](../common/accessibility#color-contrast) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> |
23+
| [Mobile Device Support](../common/accessibility#mobile-device-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> |
24+
| [Keyboard Navigation Support](../common/accessibility#keyboard-navigation-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> |
25+
| [Axe-core Accessibility Validation](../common/accessibility#ensuring-accessibility) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> |
2626

2727
<style>
2828
.post .post-content img {
2929
display: inline-block;
3030
margin: 0.5em 0;
3131
}
3232
</style>
33-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> - All features of the component meet the requirement.</div>
34-
35-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Intermediate"> - Some features of the component do not meet the requirement.</div>
36-
37-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="No"> - The component does not meet the requirement.</div>
33+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirement"> - All features of the component meet the requirement.</div>
34+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Partially meets requirement"> - Some features of the component do not meet the requirement.</div>
35+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="Not supported"> - The component does not meet the requirement.</div>
3836

3937
## WAI-ARIA attributes
4038

@@ -49,10 +47,10 @@ The TextBox uses the `textbox` role and following ARIA properties for its elemen
4947

5048
## Ensuring accessibility
5149

52-
The Blazor TextBox component's accessibility levels are ensured through an [axe-core](https://www.npmjs.com/package/axe-core) software tool during automated testing.
50+
The Blazor TextBox components accessibility is validated with the [axe-core](https://www.npmjs.com/package/axe-core) tool during automated testing.
5351

54-
The accessibility compliance of the TextBox component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/textbox) in a new window to evaluate the accessibility of the Textbox component with accessibility tools.
52+
The accessibility compliance of the TextBox component is demonstrated in the following sample. Open the [accessibility sample for TextBox](https://blazor.syncfusion.com/accessibility/textbox) in a new window to evaluate accessibility with your preferred tools. The component also supports right-to-left (RTL) rendering and high-contrast themes for improved readability and usability.
5553

5654
## See also
5755

58-
* [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> components](../common/accessibility)
56+
- [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> components](../common/accessibility)

blazor/textbox/data-binding.md

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

1010
# Data Binding in Blazor TextBox Component
1111

12-
This section briefly explains how to bind the value to the TextBox component in the following different ways.
12+
This section describes how to bind values to the TextBox component using the following approaches:
1313

14-
* One-way data binding
15-
* Two-way data binding
16-
* Dynamic value binding
17-
* Complex data binding
14+
- One-way data binding
15+
- Two-way data binding
16+
- Dynamic value binding
17+
- Complex data binding
1818

1919
## One-way binding
2020

21-
The value can be bound to the TextBox component directly for `Value` property as mentioned in the following code example. In one-way binding, pass the property or variable name along with `@` (For Ex: "@Name").
21+
Bind a value to the TextBox by assigning a property to the `Value` parameter. In one-way binding, pass the property or variable name with `@` (for example, `@Name`). UI updates occur when the bound property changes during a render (for example, inside an event handler).
2222

2323
```cshtml
2424
@using Syncfusion.Blazor.Inputs
@@ -40,7 +40,7 @@ public string Name { get; set; } = "Hello, World!";
4040

4141
## Two-way data binding
4242

43-
Two-way binding can be achieved by using `bind-Value` attribute and its support string, int, Enum, DateTime, and bool types. If the component value has been changed, it will affect all places where you bind the variable for the **bind-value** attribute.
43+
Use the `@bind-Value` attribute for two-way binding. Supported types include `string`, `int`, `enum`, `DateTime`, and `bool`. When the component value changes, the bound variable is updated, and vice versa.
4444

4545
```cshtml
4646
@using Syncfusion.Blazor.Inputs
@@ -58,9 +58,8 @@ public string Name { get; set; } = "Syncfusion";
5858

5959
## Dynamic value binding
6060

61-
The property value can be changed dynamically by manually calling the `StateHasChanged()` method inside public event of **Blazor TextBox component** only. This method notifies the component that its state has changed and queues a re-render.
61+
The component can update styles or other parameters dynamically in response to events. Calling `StateHasChanged()` notifies the component to re-render; event callbacks typically trigger re-render automatically, so this call may be optional depending on the scenario.
6262

63-
There is no need to call this method for native events since it’s called after any life cycle method and can also be invoked manually to trigger a re-render.
6463
```cshtml
6564
@using Syncfusion.Blazor.Inputs
6665
@@ -85,7 +84,7 @@ There is no need to call this method for native events since it’s called after
8584

8685
## Complex data binding
8786

88-
The complex data values can be bound to the TextBox component.The following code demonstrates how to bind complex data values to the TextBox component.
87+
Bind nested (complex) data by referencing the property path in the `Value` parameter.
8988

9089
```cshtml
9190
@using Syncfusion.Blazor.Inputs;

blazor/textbox/events.md

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

1010
# Events in Blazor TextBox Component
1111

12-
This section explains the list of events of the TextBox component which will be triggered for appropriate TextBox actions.
12+
This section lists the TextBox events and when they are triggered during user interactions.
1313

1414
## Blur
1515

16-
`Blur` event triggers when the TextBox has focus-out.
16+
The `Blur` event triggers when the TextBox loses focus.
1717

1818
```cshtml
1919
@using Syncfusion.Blazor.Inputs
@@ -30,7 +30,7 @@ This section explains the list of events of the TextBox component which will be
3030

3131
## Created
3232

33-
`Created` event triggers when the TextBox component is created.
33+
The `Created` event triggers after the TextBox component is initialized and rendered.
3434

3535
```cshtml
3636
@using Syncfusion.Blazor.Inputs
@@ -47,7 +47,7 @@ This section explains the list of events of the TextBox component which will be
4747

4848
## Destroyed
4949

50-
`Destroyed` event triggers when the TextBox component is destroyed.
50+
The `Destroyed` event triggers when the TextBox component is disposed.
5151

5252
```cshtml
5353
@using Syncfusion.Blazor.Inputs
@@ -64,7 +64,7 @@ This section explains the list of events of the TextBox component which will be
6464

6565
## Focus
6666

67-
`Focus` event triggers when the TextBox gets focus.
67+
The `Focus` event triggers when the TextBox receives focus.
6868

6969
```cshtml
7070
@using Syncfusion.Blazor.Inputs
@@ -81,7 +81,7 @@ This section explains the list of events of the TextBox component which will be
8181

8282
## Input
8383

84-
`Input` event triggers each time when the value of TextBox has changed.
84+
The `Input` event triggers every time the TextBox value changes (on each keystroke or input).
8585

8686
```cshtml
8787
@using Syncfusion.Blazor.Inputs
@@ -98,7 +98,7 @@ This section explains the list of events of the TextBox component which will be
9898

9999
## ValueChange
100100

101-
`ValueChange` event triggers when the content of TextBox has changed and gets focus-out.
101+
The `ValueChange` event triggers when the TextBox value is committed (typically on focus out) and has changed since it received focus.
102102

103103
```cshtml
104104
@using Syncfusion.Blazor.Inputs
@@ -115,7 +115,7 @@ This section explains the list of events of the TextBox component which will be
115115

116116
## ValueChanged
117117

118-
`ValueChanged` event specifies the callback to trigger when the value changes.
118+
The `ValueChanged` event is the parameter callback that fires when the `Value` parameter changes. It is commonly used with `@bind-Value` for two-way binding or to react to value updates programmatically.
119119

120120
```cshtml
121121
@using Syncfusion.Blazor.Inputs
@@ -130,4 +130,4 @@ This section explains the list of events of the TextBox component which will be
130130
}
131131
```
132132

133-
N> TexTBox is limited with these events and new events will be added in the future based on the user requests. If the event you are looking for is not on the list, then request [here](https://www.syncfusion.com/feedback/blazor-components).
133+
N> TextBox is limited with these events and new events will be added in the future based on the user requests. If the event you are looking for is not on the list, then request [here](https://www.syncfusion.com/feedback/blazor-components).

0 commit comments

Comments
 (0)