Skip to main content
Skip table of contents

Template Optimizations for Screen readers

To allow blind and visual impaired users to work with Screen readers, you have to make sure that the templates confirm to the WAI-ARIA specification. In the following section we'll provide you with information on optimizing your templates.

Details area in non-edit mode

To make screen readers read non-editable text in details area set tabindex attribute in reponsive-grid-area component (non-edit mode) to "0".

{{#form-container legacyController=legacyController}}
    {{#if editable}}
			<!-- Edit mode -->
        {{#responsive-grid-area tabindex="0"}}      
            <!-- Non-edit mode -->

Details area in Edit mode

Using labels

Labels for input elements should be provided to understand the context of the input Element. There are two ways to define a label for an Element:

  • setting the label directly on the element with the ariaLabel attribute:

    {{check-box checkedNumeric=editModel.Ready ariaLabel="Sendefertig"}}
  • using the labelledby attribute to reference another element by ID: 

    	<td id="checkboxLabelExample">Sendefertig:</td>
    	<td>{{check-box checkedNumeric=editModel.Ready ariaLabelledby="checkboxLabelExample"}}</td>

Using CSS to mute DOM Elements

While using the modern-table layout to structure your Details Pane you may want to prevent the Screen Reader from reading all DOM Elements in the path. This can be achieved by adding your own CSS class, i.e.:

    .silent-table, .silent-table tr, .silent-table tbody, .silent-table td {
        speak: none;

<table class="modern-table silent-table">
			<td class="editable-field">{{input value=editModel.Author type="text" ariaLabel="Autor"}}</td>

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.