To use the component, simple drag and drop the following Web Block on a page :

Sa11y  >  Sa11y

The Web Block has the following signature :

• Input Parameters
  • Activate  - Activate Sa11y Accessibility Checker on the page ?Useful for instance, to ensure the component is only available on the DEV and TST environments.
  • Language  - Language to display the component content
  • Sa11ySettings  - Global settings of the component, grouped by category
    • checkRoot  - Target Area to check
    • Exclusions  - Exclusions to ignore false positives
      • (10 parameters to set, all fully documented in their descriptions)
    • OtherFeatures  - Features that may help with integrations into various content management systems or frameworks.
      • (25 parameters to set, all fully documented in their descriptions)
    • Readability  - The readability module is based on Flesch (https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests#Flesch_reading_ease) reading ease.
      • (3 parameters to set, all fully documented in their descriptions)
    • OtherPlugins  - Turn off specific checks within the Settings panel.
      • (7 parameters to set, all fully documented in their descriptions)
    • SpecificRulesets  - Use these props to customize specific rulesets.
      • (5 parameters to set, all fully documented in their descriptions)
    • QARulesets  - Turn off or modify specific quality assurance checks.
      • (15 parameters to set, all fully documented in their descriptions)
    • Tables  - Tables related settings
      • (5 parameters to set, all fully documented in their descriptions)
    • EmbeddedContentRulesets  - All properties related to embedded content checks.
      • (6 parameters to set, all fully documented in their descriptions)
    • EmbeddedContent  - All properties related to embedded content types.
      • (3 parameters to set, all fully documented in their descriptions)
• Events
  • (none)

The demo allows you to play with all the settings, have more detailed information of all the settings, and also to see the component in action.