Accessibility

Overview

Sugar enables users to quickly perform certain tasks using keyboard shortcuts to increase productivity and accessibility. Keyboard shortcuts can be used to navigate around the list view and record view layouts for Sidecar modules, allowing users quickly select records, inline edit records, preview records, etc. There are also global shortcuts available to perform tasks such as toggling the Quick Create menu, entering the Global Search field, etc. Users can also customize the key combinations that activate each shortcut.

This documentation will cover the various keyboard shortcuts available as well as how to navigate around Sugar using your keyboard. For more information regarding accessibility for Sugar, please refer to the Accessibility information. 

Shortcut Keys

There are various shortcut keys available to easily perform actions in Sugar using your keyboard. You can use the shortcut keys to favorite a record, delete records, etc. in the Sidecar module's list view and record view layouts. In addition, the global shortcuts can be utilized throughout the user interface to perform actions such as opening the Quick Create menu, accessing the Global Search field, etc.

You can access the Keyboard Shortcuts help page by either hitting the Shift and / key or clicking the user menu in the top right of Sugar and selecting "Shortcuts".

The help page will display a table with the various shortcut keys available to use along with a description of the actions they perform. The shortcuts displayed are contextual based on what you are currently viewing in Sugar. For example, if you are viewing the Mass Update panel in the Accounts list view, then the Keyboard Shortcuts page will display shortcuts that specifically apply to this panel. Simply hit "Esc" on your keyboard or click the Close button if you wish to exit the page. You can also customize the key combinations for each shortcut by clicking the Gear button.

Global Shortcut Keys

The global shortcut keys can be used to perform the following actions in Sugar's user interface:

List View Shortcut Keys

The list view shortcut keys can be used to perform the following actions in the module's list view layout:

Record View Shortcut Keys

The record view shortcut keys can be used to perform the following actions in the module's record view layout:

Customizing Shortcut Keys

You can customize the key combinations which activate each shortcut. This is especially useful if you use the default key combinations for other functions such as typing special characters.

Use the following steps to customize the shortcuts' key combinations:

1. Access the Keyboard Shortcuts page by clicking the user avatar in the top right corner and selecting "Shortcuts".
2. Click the Gear button on the top right of the page.
   
3. Update the Key value you want to change in the Contextual Shortcuts table.
   
   Note: Depending on your operating system, the "mod" which appears in key combinations will be the Control key (for Windows and Linux computers) or the Command key (for Mac). Use "mod" to indicate the use of these keys.
4. Click "Save" to preserve your changes.

If you ever wish to revert all of your custom key combinations, click the "Restore default" option in the actions menu.

Since the Keyboard Shortcuts page shows contextually appropriate shortcuts, repeat these steps on various Sugar views in order to access all of the shortcuts.

Tabbing in Sugar

Using the Tab key (Alt+Tab for Safari browser) on your keyboard enables you to easily navigate through Sugar's navigation bar which spans down the side of the screen. Please note that the default tab order is from left to right. As you hit the Tab key, each option (e.g., home, module tabs, Doc Merge) on the navigation bar will be highlighted, and you can press "Enter" if you wish to access the module's list view, actions menu, notification's page, etc. For example, if you press "Enter" on the three-dots menu in the Accounts module tab, the corresponding Actions menu will open. If you continue to press the Tab key, you will highlight the options within the Actions menu (e.g., Create Account, View Accounts, etc.). If you continue to hit "Tab", once you have cycled through the options in the Actions menu, you will navigate to the next option (e.g., Contacts). Once you press "Enter" on another item, the Actions menu will close.

In addition, you can continue to tab outside of the navigation bar to highlight and access certain elements (e.g., Create button, Search box, Intelligence Pane, etc.) of the home page, list view, record view, etc. For example, if you continue tabbing after you get to the end of the navigation bar while viewing the Accounts list view, the tab will move onto the various elements on the page highlighting buttons, actions menu, account names, etc. You can simply hit "Enter" if you wish to perform a specific action (e.g., create a record, open the actions menu, etc.) on the list view. The tab will go through all of the currently displayed records on the list view then move onto the intelligence pane and instance URL before going back to the navigation bar again.

Tabbing in Global Search

After you tab through Sugar's navigation bar, you will access the Global Search bar at the top center of the screen where you can perform a search across the entire Sugar database. Once you enter in a search term, you can use the Up and Down arrow keys on your keyboard to navigate through the quick search results and hit the Tab key to close the Quick Search Results list and return to the search bar. In addition, you can also tab through the View All Results page to highlight and access certain elements (e.g., Search box, Intelligence Pane, Preview button, etc.) of the page as well. For more information on navigating through global search using your keyboard, please refer to the Search documentation.