Skip to content

Accessibility Guide

dbeaver-devops edited this page Dec 4, 2024 · 3 revisions

Table of contents

Overview

CloudBeaver offers you the ability to use most of its features with a keyboard and screen readers. Here you will find guidelines on how to utilize CloudBeaver effectively without a mouse, ensuring accessibility for all users. This includes options for theme customization, shortcuts and support for screen readers.

Theme settings

You can customize the appearance of CloudBeaver by adjusting the theme settings. This allows you to synchronize the theme with your system settings or choose from a light or dark theme based on your preference. For more information, see Local preferences.

Tip: Consider using browser extensions for high contrast themes for even more customization options.

Shortcuts

Use keyboard shortcuts to improve your efficiency in CloudBeaver. For a detailed list of shortcuts, see Shortcuts.

Screen readers support

CloudBeaver is compatible with screen readers, which helps users navigate and interact with the interface effectively. The platform adheres to web accessibility guidelines and supports major screen readers.

To navigate with a screen reader, use the Tab key to move the focus forward between elements. Use Shift + Tab to move the focus backward.

Note: CloudBeaver is tested primarily with screen readers like VoiceOver and JAWS.

Structure and navigation

CloudBeaver is structured into several components, referred to as Views, such as the Database Navigator, SQL Editor, and Data Editor. Each View contains a Toolbar with multiple buttons and features horizontal and vertical tabs for navigating between and within these Views.

To navigate within CloudBeaver using a screen reader, use the Tab key to move focus across interactive elements like buttons and tabs. Use arrow keys to move horizontally or vertically between tabs and toolbar options.

When you focus on any interface object, such as a table, column, tab, or cell, you can open the Context menu to access available actions for that object. To open the Context menu, navigate to the context menu button using the Tab key and press Enter.

When you are within a text area, such as the SQL Editor or a Value Panel, the behavior of the Tab key changes. Instead of navigating to the next interactive element, pressing Tab will insert an indent in the typed text. To navigate out of the text area, press Tab + Esc.

CloudBeaver Views and wizards

Learn how to use the most popular Views in CloudBeaver, focusing on navigation and operation with keyboard shortcuts and screen readers.

Database Navigator

The Database Navigator lets you see and manage your database connections and their objects. Use the arrow keys to move between items and press Enter to open or close them.

See Database Navigator shortcuts.

New connection

To create a New Connection, navigate to Connection -> New Connection in the top toolbar using keyboard, and select Database Connection.

Properties Editor

The Properties Editor shows information about the selected database object. You can move through the properties using the Tab key or the arrow keys.

SQL Editor

The SQL Editor is where you write and run your SQL scripts. Open it by choosing Open SQL Editor from the top toolbar and execute commands with Ctrl+Enter.

See SQL Editor shortcuts.

Data Editor

When you focus on the first cell of the Data Editor in the result set, screen readers will tell you the table and column name. As you move to different cells, it will announce any change in column names.

See Data Viewer shortcuts.

ER Diagrams

ER Diagrams are readable with screen readers, which will give you feedback as you move through different parts of the diagram. For more information, see ER Diagrams.

CloudBeaver Documentation

User Guide

Installation

Configuration

CloudBeaver AWS

CloudBeaver Enterprise Edition

Deployment

Clone this wiki locally