RTC Language Change Documentation Required NPM Resource Changed PR-5.3-dev Pending

User tests: Successful: 0 Unsuccessful: 0

avatar adamchaboryk
adamchaboryk
3 Feb 2025

Summary of Changes

  • Update Sa11y from 3.1.3 to 4.0.3
  • Removed the following setting fields: Contrast, Form Labels, Links (Advanced), Colour Filter, Web Components to Check, Additional Checks Always On
  • Unused language strings moved to end of file (to be removed with 6.0)
  • Introduced new "Turn Off Checks" field, where admins can turn off specific checks within Sa11y by key name

Testing Instructions

  • Ensure you have a fresh JS build via npm install
  • Settings page should only have 6 fields: Show Always, Target Area to Check, Readability Target Area, Ignore Regions, Extra Properties, Turn Off Checks
  • Within "Check Accessibility" preview mode, the Settings panel within Jooa11y/Sa11y should show a "Developer Checks" toggle.

Actual result BEFORE applying this Pull Request

image

Expected result AFTER applying this Pull Request

Plugin admin page view

Screenshot of admin showing 6 settings.

"Check Accessibility" preview mode

image

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

CC: @brianteeman

avatar adamchaboryk adamchaboryk - open - 3 Feb 2025
avatar adamchaboryk adamchaboryk - change - 3 Feb 2025
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 3 Feb 2025
Category Administration Language & Strings NPM Change Front End Plugins
avatar brianteeman
brianteeman - comment - 3 Feb 2025

Thanks @adamchaboryk

The main question would be for upgraded sites what happens to any options that were set and are no longer present

avatar adamchaboryk adamchaboryk - change - 3 Feb 2025
Labels Added: Language Change NPM Resource Changed PR-5.3-dev
avatar adamchaboryk adamchaboryk - change - 3 Feb 2025
Title
Update Jooa11y to Sa11y 4.0.3
[5.3] Update Jooa11y to Sa11y 4.0.3
avatar adamchaboryk adamchaboryk - edited - 3 Feb 2025
avatar adamchaboryk
adamchaboryk - comment - 3 Feb 2025

The main question would be for upgraded sites what happens to any options that were set and are no longer present

I think the only impact would be for any websites that utilize web components and an admin saved values in the "Web Components to Check" field. By removing this field, Sa11y won't check inside any web components with a shadow DOM. But if Web Components are not common within Joomla themes, this should be a non-issue.

avatar richard67
richard67 - comment - 3 Feb 2025

@adamchaboryk It seems you have run npm ci and not npm install or npm i, because your PR changes the package.json but not the package.lock. Therefore npm fails because inconsistency between json and lock file.

Please pull the changes from the GitHub reviews into your local branch and then run either npm install or npm i to update the lock file, and then add the changed lock file to this PR. Hint: It needs to run composer installbefore running the npm command, if not done yet.

avatar adamchaboryk
adamchaboryk - comment - 3 Feb 2025

Thanks for the instructions, @richard67! Done!

avatar brianteeman
brianteeman - comment - 4 Feb 2025

I have successfully used the Extra Properties option but took me a while to work out the turn off checks option. If I understand it correctly then its the custom ruklesets part of the docs

If so Can I suggest that the label and description for this are changed to "Custom Rulesets" https://sa11y.netlify.app/developers/props/#customizing-rulesets

avatar adamchaboryk
adamchaboryk - comment - 4 Feb 2025

Great feedback, I think I have a better solution:

I updated both inline help descriptions to specific instructions/screenshot on the Joomla page part of my Sa11y project website:

avatar brianteeman brianteeman - test_item - 4 Feb 2025 - Tested successfully
avatar brianteeman
brianteeman - comment - 4 Feb 2025

I have tested this item ✅ successfully on 2f5fcd9

great new functionality - thanks @adamchaboryk


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/44813.

avatar QuyTon QuyTon - alter_testresult - 5 Feb 2025 - brianteeman: Tested successfully
avatar QuyTon QuyTon - test_item - 5 Feb 2025 - Tested successfully
avatar QuyTon
QuyTon - comment - 5 Feb 2025

I have tested this item ✅ successfully on b5389f8


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/44813.

avatar QuyTon QuyTon - change - 5 Feb 2025
Status Pending Ready to Commit
avatar QuyTon
QuyTon - comment - 5 Feb 2025

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/44813.

avatar laoneo laoneo - change - 5 Feb 2025
Labels Added: RTC
avatar laoneo laoneo - close - 5 Feb 2025
avatar laoneo laoneo - merge - 5 Feb 2025
avatar laoneo laoneo - change - 5 Feb 2025
Status Ready to Commit Fixed in Code Base
Closed_Date 0000-00-00 00:00:00 2025-02-05 08:58:57
Closed_By laoneo
Labels Added: Documentation Required
avatar laoneo
laoneo - comment - 5 Feb 2025

Thanks!

Add a Comment

Login with GitHub to post a comment