Dashboard: Add accessible landmark markup (#36753)

* Add landmark markup

* Make panel titles h2

* Descibe panel landmarks

* Add nav elements and heading 1

* Reset line height and remove margin

* Make focus styles visible

* Change nav to section

* Add desc

* Fix focus styles cutoff

packages/grafana-e2e-selectors/src/selectors/components.ts

@@ -37,9 +37,9 @@ export const Components = {
   },
   Panels: {
     Panel: {
-      title: (title: string) => `Panel header title item ${title}`,
+      title: (title: string) => `Panel header ${title}`,
       headerItems: (item: string) => `Panel header item ${item}`,
-      containerByTitle: (title: string) => `Panel container title ${title}`,
+      containerByTitle: (title: string) => `${title} panel`,
       headerCornerInfo: (mode: string) => `Panel header ${mode}`,
     },
     Visualization: {
@@ -157,13 +157,13 @@ export const Components = {
   },
   PageToolbar: {
     container: () => '.page-toolbar',
-    item: (tooltip: string) => `Page toolbar button ${tooltip}`,
+    item: (tooltip: string) => `${tooltip}`,
   },
   QueryEditorToolbarItem: {
     button: (title: string) => `QueryEditor toolbar item button ${title}`,
   },
   BackButton: {
-    backArrow: 'Go Back button',
+    backArrow: 'Go Back',
   },
   OptionsGroup: {
     group: (title?: string) => (title ? `Options group ${title}` : 'Options group'),

packages/grafana-ui/src/components/PageLayout/PageToolbar.tsx

@@ -63,24 +63,28 @@ export const PageToolbar: FC<Props> = React.memo(
             />
           </div>
         )}
-        {parent && parentHref && (
-          <>
-            <Link className={cx(styles.titleText, styles.parentLink, styles.titleLink)} href={parentHref}>
-              {parent} <span className={styles.parentIcon}></span>
-            </Link>
-            {titleHref && (
-              <span className={cx(styles.titleText, styles.titleDivider, styles.parentLink)} aria-hidden>
-                /
-              </span>
-            )}
-          </>
-        )}
-        {titleHref && (
-          <Link className={cx(styles.titleText, styles.titleLink)} href={titleHref}>
-            {title}
-          </Link>
-        )}
-        {!titleHref && <div className={styles.titleText}>{title}</div>}
+        <nav className={styles.navElement}>
+          {parent && parentHref && (
+            <>
+              <Link className={cx(styles.titleText, styles.parentLink, styles.titleLink)} href={parentHref}>
+                {parent} <span className={styles.parentIcon}></span>
+              </Link>
+              {titleHref && (
+                <span className={cx(styles.titleText, styles.titleDivider, styles.parentLink)} aria-hidden>
+                  /
+                </span>
+              )}
+            </>
+          )}
+          {titleHref && (
+            <h1 className={styles.h1Styles}>
+              <Link className={cx(styles.titleText, styles.titleLink)} href={titleHref}>
+                {title}
+              </Link>
+            </h1>
+          )}
+          {!titleHref && <h1 className={styles.titleText}>{title}</h1>}
+        </nav>
         {leftItems?.map((child, index) => (
           <div className={styles.leftActionItem} key={index}>
             {child}
@@ -147,6 +151,14 @@ const getStyles = (theme: GrafanaTheme2) => {
       min-width: 0;
       overflow: hidden;
     `,
+    navElement: css`
+      display: flex;
+    `,
+    h1Styles: css`
+      margin: 0;
+      line-height: inherit;
+      display: flex;
+    `,
     parentIcon: css`
       margin-left: ${theme.spacing(0.5)};
     `,

public/app/AppWrapper.tsx

@@ -97,7 +97,7 @@ export class AppWrapper extends React.Component<AppWrapperProps, AppWrapperState
                 <div className="grafana-app">
                   <Router history={locationService.getHistory()}>
                     <SideMenu />
-                    <div className="main-view">
+                    <main className="main-view">
                       <div
                         ref={this.container}
                         dangerouslySetInnerHTML={{
@@ -110,7 +110,7 @@ export class AppWrapper extends React.Component<AppWrapperProps, AppWrapperState
                       {bodyRenderHooks.map((Hook, index) => (
                         <Hook key={index.toString()} />
                       ))}
-                    </div>
+                    </main>
                   </Router>
                 </div>
                 <LiveConnectionWarning />

public/app/core/components/sidemenu/SideMenu.tsx

@@ -24,7 +24,7 @@ export const SideMenu: FC = React.memo(() => {
   }
 
   return (
-    <div className="sidemenu" data-testid="sidemenu">
+    <nav className="sidemenu" data-testid="sidemenu">
       <a href={homeUrl} className="sidemenu__logo" key="logo">
         <Branding.MenuLogo />
       </a>
@@ -37,7 +37,7 @@ export const SideMenu: FC = React.memo(() => {
       </div>
       <TopSection key="topsection" />
       <BottomSection key="bottomsection" />
-    </div>
+    </nav>
   );
 });
 

public/app/features/dashboard/components/DashNav/DashNav.tsx

@@ -114,9 +114,10 @@ class DashNav extends PureComponent<Props> {
     }
 
     if (canStar) {
+      let desc = isStarred ? 'Unmark as favorite' : 'Mark as favorite';
       buttons.push(
         <DashNavButton
-          tooltip="Mark as favorite"
+          tooltip={desc}
           icon={isStarred ? 'favorite' : 'star'}
           iconType={isStarred ? 'mono' : 'default'}
           iconSize="lg"
@@ -127,11 +128,12 @@ class DashNav extends PureComponent<Props> {
     }
 
     if (canShare) {
+      let desc = 'Share dashboard or panel';
       buttons.push(
         <ModalsController key="button-share">
           {({ showModal, hideModal }) => (
             <DashNavButton
-              tooltip="Share dashboard or panel"
+              tooltip={desc}
               icon="share-alt"
               iconSize="lg"
               onClick={() => {

public/app/features/dashboard/containers/DashboardPage.tsx

@@ -317,7 +317,7 @@ export class UnthemedDashboardPage extends PureComponent<Props, State> {
     return (
       <div className={containerClassNames}>
         {kioskMode !== KioskMode.Full && (
-          <div aria-label={selectors.pages.Dashboard.DashNav.nav}>
+          <header aria-label={selectors.pages.Dashboard.DashNav.nav}>
             <DashNav
               dashboard={dashboard}
               title={dashboard.title}
@@ -327,7 +327,7 @@ export class UnthemedDashboardPage extends PureComponent<Props, State> {
               kioskMode={kioskMode}
               hideTimePicker={dashboard.timepicker.hidden}
             />
-          </div>
+          </header>
         )}
 
         <DashboardPrompt dashboard={dashboard} />
@@ -343,9 +343,9 @@ export class UnthemedDashboardPage extends PureComponent<Props, State> {
             <div className={styles.dashboardContent}>
               {initError && <DashboardFailed />}
               {!editPanel && kioskMode === KioskMode.Off && (
-                <div aria-label={selectors.pages.Dashboard.SubMenu.submenu}>
+                <section aria-label={selectors.pages.Dashboard.SubMenu.submenu}>
                   <SubMenu dashboard={dashboard} annotations={dashboard.annotations.list} links={dashboard.links} />
-                </div>
+                </section>
               )}
 
               <DashboardGrid

public/app/features/dashboard/dashgrid/PanelChrome.tsx

@@ -434,7 +434,10 @@ export class PanelChrome extends Component<Props, State> {
     });
 
     return (
-      <div className={containerClassNames} aria-label={selectors.components.Panels.Panel.containerByTitle(panel.title)}>
+      <section
+        className={containerClassNames}
+        aria-label={selectors.components.Panels.Panel.containerByTitle(panel.title)}
+      >
         <PanelHeader
           panel={panel}
           dashboard={dashboard}
@@ -456,7 +459,7 @@ export class PanelChrome extends Component<Props, State> {
             return this.renderPanel(width, height);
           }}
         </ErrorBoundary>
-      </div>
+      </section>
     );
   }
 }

public/app/features/dashboard/dashgrid/PanelHeader/PanelHeader.tsx

@@ -1,7 +1,7 @@
 import React, { FC } from 'react';
-import { cx } from '@emotion/css';
-import { DataLink, PanelData } from '@grafana/data';
-import { Icon } from '@grafana/ui';
+import { cx, css } from '@emotion/css';
+import { DataLink, GrafanaTheme2, PanelData } from '@grafana/data';
+import { Icon, useStyles2 } from '@grafana/ui';
 import { selectors } from '@grafana/e2e-selectors';
 
 import PanelHeaderCorner from './PanelHeaderCorner';
@@ -30,6 +30,7 @@ export const PanelHeader: FC<Props> = ({ panel, error, isViewing, isEditing, dat
   const onCancelQuery = () => panel.getQueryRunner().cancelQuery();
   const title = panel.getDisplayTitle();
   const className = cx('panel-header', !(isViewing || isEditing) ? 'grid-drag-handle' : '');
+  const styles = useStyles2(panelStyles);
 
   return (
     <>
@@ -57,7 +58,7 @@ export const PanelHeader: FC<Props> = ({ panel, error, isViewing, isEditing, dat
                     size="sm"
                   />
                 ) : null}
-                <span className="panel-title-text">{title}</span>
+                <h2 className={styles.titleText}>{title}</h2>
                 <Icon name="angle-down" className="panel-menu-toggle" />
                 <PanelHeaderMenuWrapper panel={panel} dashboard={dashboard} show={panelMenuOpen} onClose={closeMenu} />
                 {data.request && data.request.timeInfo && (
@@ -73,3 +74,25 @@ export const PanelHeader: FC<Props> = ({ panel, error, isViewing, isEditing, dat
     </>
   );
 };
+
+const panelStyles = (theme: GrafanaTheme2) => {
+  return {
+    titleText: css`
+      text-overflow: ellipsis;
+      overflow: hidden;
+      white-space: nowrap;
+      max-width: calc(100% - 38px);
+      cursor: pointer;
+      font-weight: ${theme.typography.fontWeightMedium};
+      font-size: ${theme.typography.body.fontSize};
+      margin: 0;
+
+      &:hover {
+        color: ${theme.colors.text.primary};
+      }
+      .panel-has-alert & {
+        max-width: calc(100% - 54px);
+      }
+    `,
+  };
+};

public/app/features/dashboard/dashgrid/PanelHeader/PanelHeaderMenuTrigger.tsx

@@ -33,9 +33,9 @@ export const PanelHeaderMenuTrigger: FC<Props> = ({ children, ...divProps }) =>
   );
 
   return (
-    <div {...divProps} className="panel-title-container" onClick={onMenuToggle} onMouseDown={onMouseDown}>
+    <header {...divProps} className="panel-title-container" onClick={onMenuToggle} onMouseDown={onMouseDown}>
       {children({ panelMenuOpen, closeMenu: () => setPanelMenuOpen(false) })}
-    </div>
+    </header>
   );
 };
 

public/sass/components/_panel_header.scss

@@ -37,22 +37,6 @@ $panel-header-no-title-zindex: 1;
   align-items: center;
 }
 
-.panel-title-text {
-  text-overflow: ellipsis;
-  overflow: hidden;
-  white-space: nowrap;
-  max-width: calc(100% - 38px);
-  cursor: pointer;
-  font-weight: $font-weight-semi-bold;
-
-  &:hover {
-    color: $link-hover-color;
-  }
-  .panel-has-alert & {
-    max-width: calc(100% - 54px);
-  }
-}
-
 .panel-menu-container {
   width: 0px;
   height: 19px;