Triggering Accessibility Widget Events

The accessibility widget enables specific events to be triggered programmatically (e.g. changes to language, profile, contrast, etc.), allowing integration with external systems, automation of actions, and customisation of the widget to individual user needs.

Examples of applications:

  • Automatic activation of high contrast mode when the user enters the website.
  • Change the widget language depending on the language of the page content.
  • Setting the preferred accessibility profile (e.g. for people with dyslexia or visual impairment) based on saved user settings.

The following is a list of available events

NameDescription
AccessibilityContrastTogglechange page contrast
AccessibilityContrastSetapplying contrast to the page (true/false)
AccessibilityInvertColorToggletoggle page color inversion
AccessibilityInvertColorSetapply page color inversion (true/false)
AccessibilityUnderlineToggletoggle link underlining
AccessibilityUnderlineSetapplying link underlining (true/false)
AccessibilityFontSizeSettext size setting (1 – 5)
AccessibilityFontSizeIncreaseincrease text
AccessibilityFontSizeDecreasedecrease text
AccessibilityFontSizeLevelUpincreasing text size with looping
AccessibilityLetterSpacingLevelUpchange letter spacing with looping
AccessibilityLetterSpacingSetsetting the letter spacing (1 – 5)
AccessibilityLineHeightLevelUpline height adjustment with looping
AccessibilityLineHeightSetset line height (1–5)
AccessibilitySaturationLevelUpcolor saturation adjustment
AccessibilitySaturationSetset color saturation (1–3)
AccessibilityTextToSpeechToggletoggle text-to-speech
AccessibilityTextToSpeechSetapply text-to-speech (true/false)
AccessibilityEnlargeCursorToggletoggle enlarged cursor
AccessibilityEnlargeCursorSetapply enlarged cursor (true/false)
AccessibilityHideMediaToggletoggle hiding media
AccessibilityHideMediaSetapply hiding media (true/false)
AccessibilityDisableAnimationsToggletoggle page animations
AccessibilityDisableAnimationsSetapply animation disabling (true/false)
AccessibilityShowLineToggletoggle reading guide
AccessibilityShowLineSetapply reading guide (true/false)
AccessibilityDyslexicToggletoggle dyslexic-friendly font
AccessibilityDyslexicSetapply dyslexic-friendly font (true/false)
AccessibilityProfileMotorImpairedToggletoggle motor impairment profile
AccessibilityProfileMotorImpairedSetapply motor impairment profile (true/false)
AccessibilityProfileLowVisionToggletoggle low vision profile
AccessibilityProfileLowVisionSetapply low vision profile (true/false)
AccessibilityProfileColorBlindToggletoggle color blindness profile
AccessibilityProfileColorBlindSetapply color blindness profile (true/false)
AccessibilityProfileDyslexiaToggletoggle dyslexia profile
AccessibilityProfileDyslexiaSetapply dyslexia profile (true/false)
AccessibilityProfileBlindToggletoggle blind user profile
AccessibilityProfileBlindSetapply blind user profile (true/false)
AccessibilityProfileEpilepticToggletoggle epilepsy-safe profile
AccessibilityProfileEpilepticSetapply epilepsy-safe profile (true/false)
AccessibilityProfileAdhdToggletoggle ADHD profile
AccessibilityProfileAdhdSetapply ADHD profile (true/false)
AccessibilityProfileCognitiveAndLearningToggletoggle cognitive & learning profile
AccessibilityProfileCognitiveAndLearningSetapply cognitive & learning profile (true/false)
AccessibilityLanguageSetset widget language
AccessibilityMenuOpenopen accessibility menu
AccessibilityMenuCloseclose accessibility menu
AccessibilityResetreset all settings to default

You can use these events in your application by calling events in the following way:

accessibility.emit('<span class="name-and-value"><span class="object-value-string value" title="AccessibilityContrastToggle">AccessibilityContrastToggle</span></span>') accessibility.emit('<span class="name-and-value"><span class="object-value-string value" title="AccessibilityContrastToggle">AccessibilityContrastSet</span></span>', true) accessibility.emit('<span class="name-and-value"><span class="object-value-string value" title="AccessibilityFontSizeSet">AccessibilityFontSizeSet</span></span>', 3) accessibility.emit('AccessibilityLanguageSet', 'pl') accessibility.emit('AccessibilityMenuOpen')

Related posts

Still looking for answers?

Ask our experts using online chat

Contact us