Skip to content

Commit 1b1c5b6

Browse files
Merge pull request #6915 from syncfusion-content/BLAZ-983104-In-place
Updated the UG Documentation for In-Place-editor
2 parents 690adea + ccfbf55 commit 1b1c5b6

16 files changed

+158
-163
lines changed

blazor/in-place-editor/accessibility.md

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

1010
# Accessibility in Blazor In-place editor component
1111

12-
The [Blazor In-place editor](https://www.syncfusion.com/blazor-components/blazor-in-place-editor) 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 In-place editor](https://www.syncfusion.com/blazor-components/blazor-in-place-editor) component follows 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.
1313

14-
The accessibility compliance for the Blazor In-place editor component is outlined below.
14+
The accessibility compliance for the Blazor In-place Editor 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 requirements"> |
19+
| [Section 508 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirements"> |
20+
| [Screen Reader Support](../common/accessibility#screen-reader-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirements"> |
21+
| [Right-To-Left Support](../common/accessibility#right-to-left-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirements"> |
22+
| [Color Contrast](../common/accessibility#color-contrast) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirements"> |
23+
| [Mobile Device Support](../common/accessibility#mobile-device-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirements"> |
24+
| [Keyboard Navigation Support](../common/accessibility#keyboard-navigation-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirements"> |
25+
| [Axe-core Accessibility Validation](../common/accessibility#ensuring-accessibility) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets requirements"> |
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>
33+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Meets all requirements"> - All features of the component meet the requirement.</div>
3434

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>
35+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Partially meets requirements"> - Some features of the component do not meet the requirement.</div>
3636

37-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="No"> - The component does not meet the requirement.</div>
37+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="Does not meet requirements"> - The component does not meet the requirement.</div>
3838

3939
## Keyboard interaction
4040

41-
You can use the following key shortcuts to access the Blazor In-place editor without interruptions:
41+
Use the following key shortcuts to operate the Blazor In-place Editor efficiently with a keyboard:
4242

4343
| Windows | Mac | Actions |
4444
| --- | --- | --- |
45-
| <kbd>Tab</kbd> | <kbd>Tab</kbd> | Helps in focusing the Inplace editor on the page and switching between the consecutive Inplace editor bars. |
46-
| <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Helps in focusing the previous Inplace editor bar element on the Inplace editor. |
45+
| <kbd>Tab</kbd> | <kbd>Tab</kbd> | Move focus to the In-place Editor on the page and navigate forward between consecutive In-place Editor instances. |
46+
| <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Move focus to the previous In-place Editor instance or to the previous focusable element. |
4747

4848
## Ensuring accessibility
4949

5050
The Blazor In-place editor component's accessibility levels are ensured through an [axe-core](https://www.npmjs.com/package/axe-core) software tool during automated testing.
5151

52-
The accessibility compliance of the Inplace editor component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/inplace-editor) in a new window to evaluate the accessibility of the Inplace editor component with accessibility tools.
52+
The accessibility compliance of the In-place Editor component is shown in the following sample. Open the sample (https://blazor.syncfusion.com/accessibility/inplace-editor) in a new window to evaluate the accessibility of the In-place Editor component with accessibility tools.
5353

5454
## See also
5555

blazor/in-place-editor/buttons.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title: Buttons in Blazor In-place Editor Component | Syncfusion
44
description: Checkout and learn here all about Buttons in Syncfusion Blazor In-place Editor component and much more.
55
platform: Blazor
6-
control: In Place Editor
6+
control: In-place Editor
77
documentation: ug
88
---
99

blazor/in-place-editor/configuration.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,25 @@ layout: post
33
title: Configuration in Blazor In-place Editor Component | Syncfusion
44
description: Checkout and learn here all about Configuration in Syncfusion Blazor In-place Editor component and more.
55
platform: Blazor
6-
control: In Place Editor
6+
control: In-place Editor
77
documentation: ug
88
---
99

1010
# Configuration in Blazor In-place Editor Component
1111

1212
## Rendering modes
1313

14-
This section explains the supported rendering modes of the In-place Editor. The possible Rendering modes are:
14+
This section explains the supported rendering modes of the In-place Editor. Supported rendering modes:
1515

16-
* Popup
17-
* Inline
16+
- Popup
17+
- Inline
1818

19-
N> By default, `Inline` mode will be rendered when opening an editor.
19+
N> Inline mode is the default when the editor opens.
2020

21-
* For `Popup` mode, the editable container displays as like tooltip or popover above the element.
21+
- Popup mode displays the editable container like a tooltip or popover above the target element.
22+
- Inline mode replaces the element with the editable container. To open the editor in Inline mode, set Mode to Inline.
2223

23-
* For `Inline` mode, the editable container displays instead of the element. To render `Inline` mode while opening the editor, specify `Mode` as `Inline`.
24-
25-
In the following code block, the In-place Editor renders with `Inline` mode. You can dynamically switch into another mode by changing the drop-down item value.
24+
In the following example, the In-place Editor renders in Inline mode. The rendering mode can be switched dynamically by changing the drop-down value.
2625

2726
```cshtml
2827
@@ -96,11 +95,11 @@ In the following code block, the In-place Editor renders with `Inline` mode. You
9695
9796
```
9897

99-
### Pop-up customization
98+
### Popup customization
10099

101-
In-place Editor popup mode can be customized by using the `InPlaceEditorPopupSettings` tag.
100+
Popup mode can be customized by using the `InPlaceEditorPopupSettings` tag.
102101

103-
Popup mode is rendered by using the Blazor Tooltip component, so you can use the tooltip properties and events to customize the behavior of popup via the `InPlaceEditorPopupSettings` by configuring tooltip properties.
102+
Popup mode is rendered using the Blazor Tooltip component, so tooltip properties and events can be used to customize popup behavior through `InPlaceEditorPopupSettings` by configuring tooltip properties
104103

105104
N> For more details, refer to the tooltip documentation [section](../tooltip/getting-started-webapp).
106105

@@ -109,11 +108,11 @@ N> For more details, refer to the tooltip documentation [section](../tooltip/get
109108
The event action of the editor will be enabled in the edit mode based on the `EditableOn` property. By default, `Click` is enabled.
110109
The following options are also supported:
111110

112-
* **Click**: The editor will be opened on single-click actions.
113-
* **DoubleClick**: The editor will be opened on double-click actions and it is not applicable for the edit icon.
114-
* **EditIconClick**: Disables the editing of event action of input and allows the users to edit only through edit icon.
111+
* **Click**: Opens the editor on a single click.
112+
* **DoubleClick**: Opens the editor on a double click. This option does not apply to the edit icon.
113+
* **EditIconClick**: Disables input-triggered editing and allows editing only through the edit icon.
115114

116-
N> In-place Editor gets focus by pressing the `tab` key from the previous focusable DOM element. The editor can be opened by pressing the `enter` key.
115+
N> The In-place Editor receives focus by pressing the Tab key from the previous focusable element. Press `Enter`to open the editor.
117116

118117
In the following code block, when switching the drop-down item, the selected value is assigned to the `EditableOn` property. The editor will be opened when you double click on the input.
119118

@@ -206,14 +205,13 @@ In the following code block, when switching the drop-down item, the selected val
206205

207206
## Action on focus out
208207

209-
Action will be performed when the user clicks outside the container. That means, focusing out of the editable content can be handled by the `ActionOnBlur` property. By default, `Submit` is enabled.
210-
It also has the following options.
208+
An action can be performed when clicking outside the editor container. This is controlled by the ActionOnBlur property. By default, Submit is enabled. The following options are supported:
211209

212-
* **Cancel**: Cancels the editing and resets the old content.
213-
* **Submit**: Submits the edited content to the server.
214-
* **Ignore**: No action will be performed with this type.
210+
- Cancel: Cancels editing and restores the previous content.
211+
- Submit: Saves the edited content.
212+
- Ignore: Performs no action.
215213

216-
In the following code block, when switching drop-down items, the selected value is assigned to the `ActionOnBlur` property.
214+
In the following example, the selected drop-down value is assigned to ActionOnBlur.
217215

218216
```cshtml
219217
@using Syncfusion.Blazor.InPlaceEditor
@@ -301,7 +299,7 @@ In the following code block, when switching drop-down items, the selected value
301299

302300
By default, the In-place Editor input element is highlighted with a dotted underline. To remove dotted underline from input element, add `{"data-underline", "false" }` attribute at In-place Editor root element.
303301

304-
The following code block indicates the intractable and normal display modes with different examples.
302+
The following example shows interactive and normal display modes.
305303

306304
```cshtml
307305
@@ -365,7 +363,7 @@ The following code block indicates the intractable and normal display modes with
365363
366364
```
367365

368-
![Blazor In-place Editor Text with Underline](./images/blazor-inplace-editor-text-with-under-line.png)
366+
![Blazor In-place Editor text with underline](./images/blazor-inplace-editor-text-with-under-line.png)
369367

370368
## See Also
371369

blazor/in-place-editor/controls.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ layout: post
33
title: List of Components in Blazor In-place Editor Component | Syncfusion
44
description: Checkout and learn here all about List of Components in Syncfusion Blazor In-place Editor component and more.
55
platform: Blazor
6-
control: In Place Editor
6+
control: In-place Editor
77
documentation: ug
88
---
99

1010
# List of Components in Blazor In-place Editor Component
1111

12-
In-place Editor renders various components based on the `Type` property and the Editor components should be rendered inside the In-place Editor. Also, the two-way binding between the In-place Editor and its EditorComponent needs to be configured. It is used to update the EditorComponent value into the In-place Editor component.
12+
The In-place Editor renders different editor components based on the `Type` property. Each editor component must be placed inside the In-place Editor and configured with two-way data binding between the In-place Editor and the embedded editor component to keep values in sync.
1313

14-
The following table explains Editor components name and their configurations.
14+
The following table lists the supported editor components and their corresponding Type values.
1515

1616
| [AutoComplete](../autocomplete/getting-started) (`AutoComplete`) | [TextBox](../textbox/getting-started) (`Text`) |
1717
| [ComboBox](../combobox/getting-started) (`ComboBox`) | [DatePicker](../datepicker/getting-started) (`Date`) |

blazor/in-place-editor/data-binding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title: Data Binding in Blazor In-place Editor Component | Syncfusion
44
description: Checkout and learn here all about Data Binding in Syncfusion Blazor In-place Editor component and more.
55
platform: Blazor
6-
control: In Place Editor
6+
control: In-place Editor
77
documentation: ug
88
---
99

blazor/in-place-editor/events.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ layout: post
33
title: Events in Blazor In-place Editor Component | Syncfusion
44
description: Checkout and learn here all about Events in Syncfusion Blazor In-place Editor component and much more.
55
platform: Blazor
6-
control: In Place Editor
6+
control: In-place Editor
77
documentation: ug
88
---
99

1010
# Events in Blazor In-place Editor Component
1111

12-
This section explains the list of events of the In-place Editor's component which will be triggered for appropriate In-place Editor's actions.
12+
This section describes the events available in the In-place Editor component and when they are raised during typical actions. The events include: Created, OnActionBegin, OnActionSuccess, OnActionFailure, ValueChange, and Destroyed.
1313

1414
## Created
1515

16-
`Created` event triggers once the component rendering is completed.
16+
`Created` event is raised after the component has completed rendering.
1717

1818
```cshtml
1919
@@ -34,7 +34,7 @@ This section explains the list of events of the In-place Editor's component whic
3434

3535
## OnActionBegin
3636

37-
`OnActionBegin` event triggers before the data submitted to the server.
37+
`OnActionBegin` event is raised before data is submitted to the server as part of a save/update action. Use this event for preprocessing tasks such as validation or modifying the request.
3838

3939
```cshtml
4040
@@ -55,7 +55,7 @@ This section explains the list of events of the In-place Editor's component whic
5555

5656
## OnActionSuccess
5757

58-
`OnActionSuccess` event triggers when data is submitted successfully to the server.
58+
`OnActionSuccess` event is raised when data is successfully submitted to the server and a successful response is received.
5959

6060
```cshtml
6161
@@ -76,7 +76,7 @@ This section explains the list of events of the In-place Editor's component whic
7676

7777
## OnActionFailure
7878

79-
`OnActionFailure` event triggers when data submission failed.
79+
`OnActionFailure` event is raised when a data submission fails.
8080

8181
```cshtml
8282
@@ -97,7 +97,7 @@ This section explains the list of events of the In-place Editor's component whic
9797

9898
## ValueChange
9999

100-
`ValueChange` event triggers when the integrated component value has changed that render based on the `type` property in the In-place editor.
100+
`ValueChange` event is raised when the value of the integrated editor changes, regardless of the editor rendered via the `Type` property.
101101

102102
```cshtml
103103
@@ -118,7 +118,7 @@ This section explains the list of events of the In-place Editor's component whic
118118

119119
## Destroyed
120120

121-
`Destroyed` event triggers when the component gets destroyed.
121+
`Destroyed` event is raised when the component is disposed.
122122

123123
```cshtml
124124

0 commit comments

Comments
 (0)