Skip to content

docs(DockManager): add dockmanager documentation #2742

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 10, 2025
Merged

docs(DockManager): add dockmanager documentation #2742

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
652f9e3
docs(DockManager): add dockmanager documentation
xristianstefanov Feb 4, 2025
f986048
docs: update accessibility and keyboard-nav specs
kendo-bot Feb 4, 2025
5007bf9
chore(DockManager): apply suggestions as per comments
xristianstefanov Feb 10, 2025
101676e
chore(DockManager): remove highlighted tip
xristianstefanov Feb 10, 2025
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
95 changes: 95 additions & 0 deletions components/dockmanager/accessibility/wai-aria-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: Wai-Aria Support
page_title: Telerik UI for Blazor DockManager Documentation | DockManager Accessibility
description: "Get started with the Telerik UI for Blazor DockManager and learn about its accessibility support for WAI-ARIA, Section 508, and WCAG 2.2."
tags: telerik,blazor,accessibility,wai-aria,wcag
slug: dockmanager-wai-aria-support
position: 50
---

# Blazor DockManager Accessibility

@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)



Out of the box, the Telerik UI for Blazor DockManager provides extensive accessibility support and enables users with disabilities to acquire complete control over its features.


The DockManager is compliant with the [Web Content Accessibility Guidelines (WCAG) 2.2 AA](https://www.w3.org/TR/WCAG22/) standards and [Section 508](https://www.section508.gov/) requirements, follows the [Web Accessibility Initiative - Accessible Rich Internet Applications (WAI-ARIA)](https://www.w3.org/WAI/ARIA/apg/) best practices for implementing the [keyboard navigation](#keyboard-navigation) for its `component` role, provides options for managing its focus and is tested against the most popular screen readers.

## WAI-ARIA


This section lists the selectors, attributes, and behavior patterns supported by the component and its composite elements, if any.


The DockManager component consists of multiple inner panes, each containing tools, tabs, and content that can be resized, rearranged, and interacted with.

| Selector | Attribute | Usage |
| -------- | --------- | ----- |
| `.k-dock-manager` | `role=application` | Indicates that the DockManager has its own keyboard navigation implemented. |
| | `aria-live=polite` | Defines dynamic content changes within the DockManager container that need to be announced by screen readers. |
| `.k-dock-navigator` | `aria-hidden=true` | The navigator needs to be hidden from the readers as it appears only on drag. |

### DockManager Toolbar


The Toolbar in the DockManager element of the component should implement the specification for the **Toolbar** component.

[Toolbar accessibility specification]({{Toolbar_a11y_link}})

### DockManager TabStrip


The TabStrip in the DockManager element of the component should implement the specification for the **TabStrip** component.

[TabStrip accessibility specification]({{TabStrip_a11y_link}})

### DockManager Splitter


The Splitter in the DockManager element of the component should implement the specification for the **Splitter** component.

[Splitter accessibility specification]({{Splitter_a11y_link}})

### DockManager Window


The Window elements in the DockManager element of the component should implement the specification for the **Window** component.

[Window accessibility specification]({{Window_a11y_link}})

## Section 508


The DockManager is fully compliant with the [Section 508 requirements](http://www.section508.gov/).

## Testing


The DockManager has been extensively tested automatically with [axe-core](https://github.com/dequelabs/axe-core) and manually with the most popular screen readers.

> To report any accessibility issues, contact the team through the [Telerik Support System](https://www.telerik.com/account/support-center).

### Screen Readers


The DockManager has been tested with the following screen readers and browsers combinations:

| Environment | Tool |
| ----------- | ---- |
| Firefox | NVDA |
| Chrome | JAWS |
| Microsoft Edge | JAWS |



## Keyboard Navigation

For details on how the keyboard navigation works in Telerik UI for Blazor, refer to the [Accessibility Overview](slug://accessibility-overview#keyboard-navigation) article.

## See Also

* [Blazor Dock Manager Demos](https://demos.telerik.com/blazor-ui/dockmanager/overview)
* [Accessibility in Telerik UI for Blazor](slug://accessibility-overview)
145 changes: 145 additions & 0 deletions components/dockmanager/dock-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
---
title: Dock Types
page_title: DockManager - Dock Types
description: Dock Types in the DockManager for Blazor.
slug: dockmanager-dock-types
tags: telerik,blazor,dockmanager,dock,types
published: true
position: 10
---

# Docking Panes

The Blazor DockManager component exposes the ability to dock globally or within other panes.

## Docking Types

### Global Docking

When a user drags a pane, a global docking navigator always appears. This allows the user to dock the pane to one of the component's edges, making it a root pane.

### Inner Docking

When a user drags a pane and hovers over another pane, a dock navigator for that pane appears. The user can then choose to:

* Drop the pane on any of the parent pane’s outer edges, splitting it.
* Drop it in the center of the navigator to add it as a tab within the parent pane.

## Disable Docking over Individual Panes

To disable docking over a specific pane, set its `Dockable` parameter to `false`.

>caption DockManager with disabled docking option over some panes.

`````RAZOR
<TelerikDockManager>
<DockManagerPanes>

<DockManagerContentPane Dockable="false">
<HeaderTemplate>
Customer Support
</HeaderTemplate>
<Content>
<ul>
<li>Inbox</li>
<li>Open Tickets</li>
<li>Reports</li>
<li>Settings</li>
</ul>
</Content>
</DockManagerContentPane>

<DockManagerSplitPane Dockable="false">
<Panes>

<DockManagerContentPane>
<HeaderTemplate>
<strong>Open Tickets</strong>
</HeaderTemplate>
<Content>
<ul>
<li>Ticket #1245 - Payment issue</li>
<li>Ticket #1246 - Login failure</li>
<li>Ticket #1247 - Refund request</li>
</ul>
</Content>
</DockManagerContentPane>

<DockManagerContentPane>
<HeaderTemplate>
<strong>Recent Interactions</strong>
</HeaderTemplate>
<Content>
<p>John Doe: "I need help with my subscription."</p>
<p>Jane Smith: "My order hasn’t arrived yet."</p>
<p>Michael Lee: "How do I reset my password?"</p>
</Content>
</DockManagerContentPane>

</Panes>
</DockManagerSplitPane>

<DockManagerSplitPane>
<Panes>
<DockManagerTabGroupPane>
<Panes>

<DockManagerContentPane>
<HeaderTemplate>
<strong>Analytics</strong>
</HeaderTemplate>
<Content>
<p>Overview of ticket resolution time, customer satisfaction, and response rates.</p>
</Content>
</DockManagerContentPane>

<DockManagerContentPane>
<HeaderTemplate>
<strong>Team Performance</strong>
</HeaderTemplate>
<Content>
<p>Live statistics on agent response times and workload distribution.</p>
</Content>
</DockManagerContentPane>

</Panes>
</DockManagerTabGroupPane>

<DockManagerContentPane>
<HeaderTemplate>
<strong>System Alerts</strong>
</HeaderTemplate>
<Content>
<p>New feature rollout scheduled for February 15.</p>
<p>Service downtime reported in Europe region.</p>
<p>Security update required for agent login system.</p>
</Content>
</DockManagerContentPane>

</Panes>
</DockManagerSplitPane>
</DockManagerPanes>

<DockManagerFloatingPanes>
<DockManagerSplitPane>
<Panes>

<DockManagerContentPane>
<HeaderTemplate>
<strong>Live Chat</strong>
</HeaderTemplate>
<Content>
<p>Instant messaging with support team members.</p>
<TelerikTextBox @bind-Value="Message"></TelerikTextBox>
</Content>
</DockManagerContentPane>

</Panes>
</DockManagerSplitPane>
</DockManagerFloatingPanes>
</TelerikDockManager>

@code {
private string Message { get; set; }
}
`````
Loading