Skip to content

[5.3] Update Jooa11y to Sa11y 4.0.3#44813

Merged
laoneo merged 15 commits intojoomla:5.3-devfrom
adamchaboryk:5.3-dev
Feb 5, 2025
Merged

[5.3] Update Jooa11y to Sa11y 4.0.3#44813
laoneo merged 15 commits intojoomla:5.3-devfrom
adamchaboryk:5.3-dev

Conversation

@adamchaboryk
Copy link
Contributor

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

- Updated 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.
@joomla-cms-bot joomla-cms-bot added Language Change This is for Translators NPM Resource Changed This Pull Request can't be tested by Patchtester PR-5.3-dev labels Feb 3, 2025
@brianteeman
Copy link
Contributor

Thanks @adamchaboryk

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

@adamchaboryk adamchaboryk changed the title Update Jooa11y to Sa11y 4.0.3 [5.3] Update Jooa11y to Sa11y 4.0.3 Feb 3, 2025
Co-authored-by: Richard Fath <richard67@users.noreply.github.com>
@adamchaboryk
Copy link
Contributor Author

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.

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>
Co-authored-by: Richard Fath <richard67@users.noreply.github.com>
@richard67
Copy link
Member

@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.

@adamchaboryk
Copy link
Contributor Author

Thanks for the instructions, @richard67! Done!

@brianteeman
Copy link
Contributor

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

@adamchaboryk
Copy link
Contributor Author

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:

@brianteeman
Copy link
Contributor

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.

@QuyTon
Copy link
Contributor

QuyTon commented Feb 5, 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.

@QuyTon
Copy link
Contributor

QuyTon commented Feb 5, 2025

RTC


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

@joomla-cms-bot joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Feb 5, 2025
@laoneo laoneo added this to the Joomla! 5.3.0 milestone Feb 5, 2025
@laoneo laoneo enabled auto-merge (squash) February 5, 2025 08:10
@laoneo laoneo disabled auto-merge February 5, 2025 08:58
@laoneo laoneo merged commit 00afe74 into joomla:5.3-dev Feb 5, 2025
3 checks passed
@joomla-cms-bot joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label Feb 5, 2025
@laoneo
Copy link
Member

laoneo commented Feb 5, 2025

Thanks!

@ghost
Copy link

ghost commented Feb 6, 2025

Related issue #41191?

@brianteeman
Copy link
Contributor

@fgsw different plugin - not related

Kostelano added a commit to JPathRu/localisation that referenced this pull request Apr 14, 2025
joomla/joomla-cms#41496 - (upmerge с 5.2х)
joomla/joomla-cms#42530 +
joomla/joomla-cms#43994 - (upmerge с 5.2х)
joomla/joomla-cms#44009 - (upmerge с 5.2х)
joomla/joomla-cms#44010 - (upmerge с 5.2х)
joomla/joomla-cms#44161 +
joomla/joomla-cms#44187 - (upmerge с 5.2х)
joomla/joomla-cms#44207 - (upmerge с 5.2х)
joomla/joomla-cms#44271 +
joomla/joomla-cms#44273 +
joomla/joomla-cms#44288 - (только для en-GB)
joomla/joomla-cms#44348 - (upmerge с 5.2х)
joomla/joomla-cms#44366 +
joomla/joomla-cms#44367 - (upmerge с 5.2х)
joomla/joomla-cms#44434 - (upmerge с 5.2х)
joomla/joomla-cms#44448 - (upmerge с 5.2х)
joomla/joomla-cms#44462 +
joomla/joomla-cms#44487 - (upmerge с 5.2х)
joomla/joomla-cms#44587 +
joomla/joomla-cms#44600 +
joomla/joomla-cms#44604 +
joomla/joomla-cms#44621 - (upmerge с 5.2х)
joomla/joomla-cms#44623 +
joomla/joomla-cms#44632 +
joomla/joomla-cms#44640 - (позже был REVERT joomla/joomla-cms#44845)
joomla/joomla-cms#44714 - (upmerge с 5.2х)
joomla/joomla-cms#44756 +
joomla/joomla-cms#44768 - (upmerge с 5.2х)
joomla/joomla-cms#44792 - (только для en-GB)
joomla/joomla-cms#44813 +
joomla/joomla-cms#44822 - (upmerge с 5.2х)
joomla/joomla-cms#44839 +
joomla/joomla-cms#44871 +
joomla/joomla-cms#44954 +
joomla/joomla-cms#45034 - (upmerge с 5.2х)
joomla/joomla-cms#45058 - (только для en-GB)
joomla/joomla-cms#45064 +
joomla/joomla-cms#45078 - (только для en-GB)
joomla/joomla-cms#45130 - (upmerge с 5.2х)
joomla/joomla-cms#45240 - (upmerge с 5.2х)
joomla/joomla-cms#45246 - (только для др. пакетов)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Language Change This is for Translators NPM Resource Changed This Pull Request can't be tested by Patchtester

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants