preignition/program-user-docs
accessiblesurveys
  • TRAINING COURSE
    • Introduction
    • Session 1- Creating a new survey
    • Session 2- Adding accessibility options to a Form
    • Session 3- Translating a Form into different languages
    • Session 4- Sharing your survey using the Survey Editor
    • Session 5- Analysing your survey responses and exporting your survey data
  • TUTORIALS
    • Introduction to creating a new survey
    • Introduction editing a form
    • Introduction to testing a form
    • Introduction to publishing a form
    • Introduction to Easy Read
    • Introduction to Sign Language
    • Introduction to form logic
    • Introduction to the Customer Portal
  • GUIDANCE NOTES
    • Survey App
      • Creating a new survey
      • Form Editor
        • Structuring a form
        • Adding questions to a form
          • Text based questions
          • Choice based questions
          • Rating, Slider, Order and Range questions
          • Media based questions
          • Introduction to free text fields
        • Testing a form
        • Publishing a form
        • Introduction to form logic
        • Advanced form logic
        • Using tooltips
        • Using Markdown
        • Adding an accessibility menu
        • Form Behaviour
        • Image Library
        • Easy Read
        • Sign Language
        • Translate forms
        • Using import/ export to translate forms
        • Access rights for forms
        • Sharing options across multiple questions
      • Survey Editor
        • Editing a survey
        • Distributing your survey
        • Survey respondent accounts
        • Redirection after completing survey
        • Language settings for surveys
        • Creating alias survey links
        • Survey batches
        • Presenting surveys
        • Survey access rights
        • Survey terms- advanced
        • Publishing surveys
      • Analytics
        • Introduction to survey analytics
        • Exporting Survey Data
    • Customer Portal
      • Portal
        • Profile
        • Subscription
      • Team
      • My Profile
      • Users
      • Using labels
  • FAQ
    • Data privacy and security
      • Why and how do we collect data?
      • How do we protect data?
      • What is GDPR?
      • What rights do individuals have under GDPR?
      • What obligations do controllers have under GDPR?
      • What obligations do processors have under GDPR?
      • Where is data stored?
      • How can I ensure that my surveys GDPR compliant?
      • How to Write GDPR-proof Privacy Policy for your Surveys
    • What is the best image size, ratio and format?
    • How to use free text
      • Convenient Class for Accessible Surveys Free Text Field
      • CSS tokens available in Markdown Free Text
      • Web-components available in Markdown Free Text
      • Accessibility Modes
    • FAQ about the Form Editor
      • How do I resolve warnings when publishing a form?
      • How can I get feedback about my survey?
    • Guide to producing Accessible Surveys
      • Producing your survey in Plain Language or Easy to Read
      • Producing your survey in sign languages
    • FAQ about survey data and analytics
      • How do I ensure that the data in my CSV file is properly formatted?
  • Release Notes
    • Form Builder
      • import/export
      • Section Container
    • Process Builder
    • Reporting
    • Survey
  • API
    • survey
    • member
Powered by GitBook
On this page
  • Step 1
  • Step 2
  • Step 3
  • Step 4
  • Step 4
  1. GUIDANCE NOTES
  2. Survey App
  3. Form Editor

Adding an accessibility menu

This guide shows you how to add an accessibility menu to your survey

PreviousUsing MarkdownNextForm Behaviour

Last updated 8 months ago

Adding an accessibility menu at the start of your survey helps makes the accessibility options more prominent to survey respondents

Step 1

Accessibility settings can be activitated by survey respondents from the accessibility settings icon which is always available in the top right hand corner of the screen.

However adding an accessibility menu to your survey can make these options more prominent.

Step 2

The accessibility menu can be added to any feild that supports Markdown. This includes the 'landing page' or a 'free text' feild within your form.

Simply copy this code to make the menu appear

<a11y-menu context="survey"></a11y-menu>

The menu allows respondents to activate, deactivate or change accessibility settings directly from the menu.

It is intelligent, in that it will only show the accessibility options that you have activated for your survey.

Step 3

This short video show you how you can add an accessibility menu to a survey's 'Landing Page';

Step 4

Alternatively, you can add an accessibility menu as the first page of your survey by following these instructions.

Add a new page and section at the beginning of your form. Give the page a title like 'Accessibility'. The section should have a name but not a title or sub title

Drag and drop to add a new 'free text' question into the section that you have just created.

Copy and paste the accessibility menu into the free text field.

<a11y-menu context="survey"></a11y-menu>

Step 4

If you have included an accessibility menu in your form, be careful if you auto translate the form.

The auto translate will translate the word "survey" in the code, and the menu will not render properly when that language is activated.

You will need to manually correct the code in the translated version of the Form.

Screenshot, showing the location of the Accessibility Settings icon in the top right hand corner of the screen
This is an example of how an accessibilty menu appears to survey respondents.
Screenshot showing an Accessibility page added at the start of a Form
Screenshot showing a new 'Free Text' feild being added to the form.  By dragging the question type from the left hand column and dropping into the middle section of the page.