Skip to content

Commit 8f4fcd7

Browse files
Merge pull request #6848 from syncfusion-content/984382-splitter
Updated the UG document for Splitter Component.
2 parents c511029 + f22c559 commit 8f4fcd7

17 files changed

+159
-117
lines changed

blazor/splitter/accessibility.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
layout: post
3-
title: Keyboard Shortcuts | Syncfusion
4-
description: Checkout and learn here all about keyboard shortcuts in Syncfusion Blazor Splitter component and more.
3+
title: Accessibility in Blazor Splitter Component | Syncfusion
4+
description: Learn about the accessibility compliance of the Syncfusion Blazor Splitter component, covering WCAG 2.2, Section 508, and keyboard navigation.
55
platform: Blazor
66
control: Splitter
77
documentation: ug
88
---
99

1010
# Accessibility in Blazor Splitter Component
1111

12-
The [Blazor Splitter](https://www.syncfusion.com/blazor-components/blazor-splitter) 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 Splitter](https://www.syncfusion.com/blazor-components/blazor-splitter) component adheres to 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 commonly used [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) for evaluating accessibility.
1313

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

@@ -37,7 +37,7 @@ The accessibility compliance for the Blazor Splitter component is outlined below
3737
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="No"> - The component does not meet the requirement.</div>
3838

3939

40-
## Keyboard interaction
40+
## Keyboard Interaction
4141

4242
The following key shortcuts can be used to access the Blazor Splitter without interruptions:
4343

@@ -51,12 +51,12 @@ The following key shortcuts can be used to access the Blazor Splitter without in
5151
| <kbd>↓</kbd> | <kbd>↓</kbd> | Helps in moving the active `Vertical` orientated splitter bar to its `Down` side. |
5252
| <kbd>Enter</kbd> | <kbd>Enter</kbd> | Helps to toggle between `Expand` and `Collapse` actions of the splitter bar when it is active. |
5353

54-
## Ensuring accessibility
54+
## Ensuring Accessibility
5555

5656
The Blazor Splitter component's accessibility levels are ensured through an [axe-core](https://www.npmjs.com/package/axe-core) software tool during automated testing.
5757

5858
The accessibility compliance of the Splitter component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/splitter) in a new window to evaluate the accessibility of the Splitter component with accessibility tools.
5959

60-
## See also
60+
## See Also
6161

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

blazor/splitter/different-layouts.md

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

1010
# Different Layouts in Blazor Splitter Component
1111

12-
By using splitter control, the different layouts can be created with multiple and nested panes.
12+
Different layouts can be created using the splitter control with multiple and nested panes.
1313

14-
## Code editor style layout
14+
## Code Editor Style Layout
1515

1616
**Step 1**: Create the element with two child to render the outer splitter.
1717

@@ -160,9 +160,9 @@ By using splitter control, the different layouts can be created with multiple an
160160

161161
```
162162

163-
Once the above configurations has been completed, the output will be displayed like [this](https://blazor.syncfusion.com/demos/splitter/code-editor-layout?theme=bootstrap5)
163+
After completing the above configurations, the output is displayed as shown [here](https://blazor.syncfusion.com/demos/splitter/code-editor-layout?theme=bootstrap5).
164164

165-
## Outlook style layout
165+
## Outlook Style Layout
166166

167167
**Step 1**: Create the element with three panes and place the elements within the pane to render `Treeview`, `Listview` and `RichTextEditor`.
168168

@@ -422,7 +422,7 @@ Once the above configurations has been completed, the output will be displayed l
422422

423423
```
424424

425-
Once the above configurations has been completed, the output will be displayed like [this](https://blazor.syncfusion.com/demos/splitter/outlook?theme=bootstrap5).
425+
After completing the above configurations, the output is displayed as shown [here](https://blazor.syncfusion.com/demos/splitter/outlook?theme=bootstrap5).
426426

427427
## See Also
428428

blazor/splitter/events.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This section explains the list of events of the splitter component which will be
1313

1414
## Created
1515

16-
`Created` event triggers after creating the splitter component with its panes.
16+
The `Created` event triggers after the Splitter component and its panes are rendered.
1717

1818
```cshtml
1919
@@ -34,7 +34,7 @@ This section explains the list of events of the splitter component which will be
3434

3535
## OnResizeStart
3636

37-
`OnResizeStart` event triggers when the split pane is started to resize.
37+
The `OnResizeStart` event triggers when a split pane begins to resize.
3838

3939
```cshtml
4040
@@ -55,7 +55,7 @@ This section explains the list of events of the splitter component which will be
5555

5656
## OnResizeStop
5757

58-
`OnResizeStop` event triggers when the resizing of split pane is stopped.
58+
The `OnResizeStop` event triggers when a split pane finishes resizing.
5959

6060
```cshtml
6161
@@ -76,7 +76,7 @@ This section explains the list of events of the splitter component which will be
7676

7777
## Resizing
7878

79-
`Resizing` event triggers when a split pane is being resized.
79+
The `Resizing` event triggers while a split pane is actively being resized.
8080

8181
```cshtml
8282
@@ -118,7 +118,7 @@ This section explains the list of events of the splitter component which will be
118118

119119
## OnExpand
120120

121-
`OnExpand` event triggers before the panes get expanded.
121+
The `OnExpand` event triggers before a pane expands.
122122

123123
```cshtml
124124
@@ -139,7 +139,7 @@ This section explains the list of events of the splitter component which will be
139139

140140
## Collapsed
141141

142-
`Collapsed` event triggers after the panes get collapsed.
142+
The `Collapsed` event triggers after a pane has collapsed.
143143

144144
```cshtml
145145
@@ -160,7 +160,7 @@ This section explains the list of events of the splitter component which will be
160160

161161
## Expanded
162162

163-
`Expanded` event triggers after the panes get expanded.
163+
The `Expanded` event triggers after a pane has expanded.
164164

165165
```cshtml
166166

blazor/splitter/expand-and-collapse.md

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

1010
# Expand and Collapse in Blazor Splitter Component
1111

12-
## Collapsible panes
12+
## Collapsible Panes
1313

14-
The Splitter panes can be configured with built-in expand and collapse functionalities. By default, the collapsible behavior is disabled. Enable the `Collapsible` behavior in the SplitterPane property to show or hide the expand or collapse icons in the panes. The panes can be dynamically expanded and collapsed by the corresponding icons.
14+
The Splitter panes include built-in expand and collapse functionalities. By default, this behavior is disabled. Enable the `Collapsible` property within the `SplitterPane` to display the expand or collapse icons. Panes can then be dynamically expanded and collapsed using these icons.
1515

16-
The following code shows how to enable collapsible behavior.
16+
The following code demonstrates enabling collapsible behavior:
1717

1818
```cshtml
1919
@@ -62,11 +62,13 @@ The following code shows how to enable collapsible behavior.
6262
6363
```
6464

65+
{% previewsample "https://blazorplayground.syncfusion.com/embed/VNVIWjDbTGevpdop?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
66+
6567
![Expand and Collapse in Blazor Splitter](./images/blazor-splitter-expand-collapse.png)
6668

67-
## Programmatically control the expand and collapse action
69+
## Programmatically Control Expand and Collapse Actions
6870

69-
The Splitter provides public method to control the expand and collapse behavior programmatically using the `Expand` and `Collapse` methods.
71+
The Splitter component provides public methods (`ExpandAsync` and `CollapseAsync`) to control pane expansion and collapse programmatically.
7072

7173
```cshtml
7274
@@ -138,12 +140,13 @@ The Splitter provides public method to control the expand and collapse behavior
138140
}
139141
140142
```
143+
{% previewsample "https://blazorplayground.syncfusion.com/embed/hZhyWttbpwHeoMpA?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
141144

142145
![Expand and Collapse in Blazor Splitter](./images/blazor-splitter-expand-collapse-dynamic.png)
143146

144-
## Specify initial state to panes
147+
## Specify Initial State to Panes
145148

146-
Specific panes can be rendered with collapsed state on page load. Specify a Boolean value to the `Collapsed` property to control this behavior. The following code explains how to collapse panes on rendering (the second panes renders with collapsed state).
149+
Specific panes can be rendered in a collapsed state upon page load. To control this behavior, set the `Collapsed` property to `true` for the desired `SplitterPane`. The following code demonstrates rendering the second pane in a collapsed state.
147150

148151
```cshtml
149152
@@ -197,6 +200,7 @@ Specific panes can be rendered with collapsed state on page load. Specify a Bool
197200
}
198201
199202
```
203+
{% previewsample "https://blazorplayground.syncfusion.com/embed/VZBeWZZlpGczrUcO?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
200204

201205
![Expand and Collapse in Blazor Splitter](./images/blazor-splitter-expand-collapse-initial.png)
202206

blazor/splitter/getting-started-webapp.md

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

1010
# Getting Started with Blazor Splitter in Blazor Web App
1111

12-
This section briefly explains about how to include [Blazor Splitter](https://www.syncfusion.com/blazor-components/blazor-splitter) component in your Blazor Web App using [Visual Studio](https://visualstudio.microsoft.com/vs/) and Visual Studio Code.
12+
This section explains how to integrate the Syncfusion [Blazor Splitter](https://www.syncfusion.com/blazor-components/blazor-splitter) component into a Blazor Web App using [Visual Studio](https://visualstudio.microsoft.com/vs/) and Visual Studio Code.
1313

1414
{% tabcontents %}
1515

@@ -19,19 +19,19 @@ This section briefly explains about how to include [Blazor Splitter](https://www
1919

2020
* [System requirements for Blazor components](https://blazor.syncfusion.com/documentation/system-requirements)
2121

22-
## Create a new Blazor Web App in Visual Studio
22+
## Create a New Blazor Web App in Visual Studio
2323

24-
You can create a **Blazor Web App** using Visual Studio 2022 via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-integration/template-studio).
24+
Create a **Blazor Web App** using Visual Studio 2022 via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-integration/template-studio).
2525

26-
You need to configure the corresponding [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and [Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=windows) while creating a Blazor Web Application.
26+
Configure the corresponding [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and [Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=windows) when creating a Blazor Web Application.
2727

2828
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Layouts and Themes NuGet in the App
2929

3030
To add **Blazor Splitter** component in the app, open the NuGet package manager in Visual Studio (*Tools → NuGet Package Manager → Manage NuGet Packages for Solution*), search and install [Syncfusion.Blazor.Layouts](https://www.nuget.org/packages/Syncfusion.Blazor.Layouts) and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/).
3131

32-
If you utilize `WebAssembly or Auto` render modes in the Blazor Web App need to be install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components NuGet packages within the client project.
32+
If `WebAssembly or Auto` render modes are utilized in the Blazor Web App need to be install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor component NuGet packages are installed within the client project.
3333

34-
Alternatively, you can utilize the following package manager command to achieve the same.
34+
Alternatively, the Package Manager Console can be used to install the required NuGet package
3535

3636
{% tabs %}
3737
{% highlight C# tabtitle="Package Manager" %}
@@ -52,11 +52,11 @@ N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are availa
5252

5353
* [System requirements for Blazor components](https://blazor.syncfusion.com/documentation/system-requirements)
5454

55-
## Create a new Blazor Web App in Visual Studio Code
55+
## Create a New Blazor Web App in Visual Studio Code
5656

57-
You can create a **Blazor Web App** using Visual Studio Code via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vsc) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-code-integration/create-project).
57+
Create a **Blazor Web App** using Visual Studio Code via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vsc) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-code-integration/create-project).
5858

59-
You need to configure the corresponding [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and [Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vsc) while creating a Blazor Web Application.
59+
Configure the corresponding [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and [Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vsc) when creating a Blazor Web Application.
6060

6161
For example, in a Blazor Web App with the `Auto` interactive render mode, use the following commands.
6262

@@ -74,10 +74,10 @@ N> For more information on creating a **Blazor Web App** with various interactiv
7474

7575
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Layouts and Themes NuGet in the App
7676

77-
If you utilize `WebAssembly` or `Auto` render modes in the Blazor Web App need to be install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components NuGet packages within the client project.
77+
If `WebAssembly` or `Auto` render modes are utilized in the Blazor Web App, install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor component NuGet packages within the client project.
7878

7979
* Press <kbd>Ctrl</kbd>+<kbd>`</kbd> to open the integrated terminal in Visual Studio Code.
80-
* Ensure you’re in the project root directory where your `.csproj` file is located.
80+
* Ensure the current directory is the project root where the `.csproj` file is located.
8181
* Run the following command to install a [Syncfusion.Blazor.Layouts](https://www.nuget.org/packages/Syncfusion.Blazor.Layouts) and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/) NuGet package and ensure all dependencies are installed.
8282

8383
{% tabs %}
@@ -118,7 +118,7 @@ Import the `Syncfusion.Blazor` and `Syncfusion.Blazor.Layouts` namespace.
118118

119119
Now, register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Service in the **~/Program.cs** file of your Blazor Web App.
120120

121-
If the **Interactive Render Mode** is set to `WebAssembly` or `Auto`, you need to register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor service in both **~/Program.cs** files of your Blazor Web App.
121+
If the **Interactive Render Mode** is `WebAssembly` or `Auto`, register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor service in both **Program.cs** files of the Blazor Web App (`server` and `client` projects).
122122

123123
{% tabs %}
124124
{% highlight c# tabtitle="Server(~/_Program.cs)" hl_lines="3 11" %}
@@ -152,7 +152,7 @@ await builder.Build().RunAsync();
152152
{% endhighlight %}
153153
{% endtabs %}
154154

155-
If the **Interactive Render Mode** is set to `Server`, your project will contain a single **~/Program.cs** file. So, you should register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Service only in that **~/Program.cs** file.
155+
If the **Interactive Render Mode** is set to `Server`, Register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Service only in the server-side **~/Program.cs** file.
156156

157157
{% tabs %}
158158
{% highlight c# tabtitle="~/_Program.cs" hl_lines="2 9" %}
@@ -173,7 +173,7 @@ var app = builder.Build();
173173
{% endhighlight %}
174174
{% endtabs %}
175175

176-
## Add stylesheet and script resources
176+
## Add Stylesheet and Script Resources
177177

178178
The theme stylesheet and script can be accessed from NuGet through [Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets). Include the stylesheet reference in the `<head>` section and the script reference at the end of the `<body>` in the **~/Components/App.razor** file as shown below:
179179

@@ -189,7 +189,7 @@ The theme stylesheet and script can be accessed from NuGet through [Static Web A
189189
</body>
190190
```
191191

192-
N> Check out the [Blazor Themes](https://blazor.syncfusion.com/documentation/appearance/themes) topic to discover various methods ([Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets), [CDN](https://blazor.syncfusion.com/documentation/appearance/themes#cdn-reference), and [CRG](https://blazor.syncfusion.com/documentation/common/custom-resource-generator)) for referencing themes in your Blazor application. Also, check out the [Adding Script Reference](https://blazor.syncfusion.com/documentation/common/adding-script-references) topic to learn different approaches for adding script references in your Blazor application.
192+
N> Check out the [Blazor Themes](https://blazor.syncfusion.com/documentation/appearance/themes) topic to discover various methods ([Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets), [CDN](https://blazor.syncfusion.com/documentation/appearance/themes#cdn-reference), and [CRG](https://blazor.syncfusion.com/documentation/common/custom-resource-generator)) for referencing themes in a Blazor application. Also, check out the [Adding Script Reference](https://blazor.syncfusion.com/documentation/common/adding-script-references) topic to learn different approaches for adding script references in a Blazor application.
193193

194194
## Add Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Splitter component
195195

@@ -260,4 +260,4 @@ N> If an **Interactivity Location** is set to `Global` and the **Render Mode** i
260260

261261
* [Getting Started with Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Web App in Visual Studio or .NET CLI](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app)
262262

263-
N> You can also explore our [Blazor Splitter example](https://blazor.syncfusion.com/demos/splitter/default-functionalities?theme=fluent) that shows you how to render and configure the Splitter.
263+
N> Explore the [Blazor Splitter example](https://blazor.syncfusion.com/demos/splitter/default-functionalities?theme=fluent) for a demonstration on rendering and configuring the Splitter.

0 commit comments

Comments
 (0)