Feature RTC Language Change NPM Resource Changed PR-5.1-dev Failure

User tests: Successful: Unsuccessful:

avatar adamchaboryk
adamchaboryk
9 Feb 2024

Continuation of #42768 based on @Fedik's review and feedback. Includes updated screenshots of changes.

(Sorry for re-creating the PR. Had issues re-basing from 5.0 to 5.1. After I renamed the branch on my fork, I inadvertently closed my PR.)

Summary of Changes

This PR adds Sa11y as a dependency, ensuring seamless and automatic updates for future Joomla releases.

  • Sa11y is added as a dependency via build/build-modules-js/settings.json.
  • Addition of several new languages.
    • New languages would be added by modifying build/build-modules-js/settings.json.
    • Automatic language detection based on page language.
    • Note: Only the admin settings will utilize Joomla's PLG language system.
  • New configuration/properties in admin settings to customize experience for content editors.

Related issue: joomla-projects/joomla-a11y-checker#75

Testing Instructions

  • Ensure you have a fresh JS build via npm install
  • Navigate to "Accessibility Check" as you would normally. Accessibility Checker should appear in same spot.
  • Add a language pack (like German for example), and ensure Accessibility Checker displays correct translation.

Actual result BEFORE applying this Pull Request

https://joomla-projects.github.io/joomla-a11y-checker/pages/errors.html

Expected result AFTER applying this Pull Request

Accessibility Check preview

View of updated accessibility checker in Accessibility Check preview.

Plugin settings with descriptions

Includes a couple of Extra Props for demonstration purposes. Extra props can accept boolean/numeric/string based on Sa11y's documentation.

View of accessibility checker plugin admin settings with descriptions.

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: I'll do a PR later to update this page https://manual.joomla.org/docs/accessibility/testing

  • No documentation changes for manual.joomla.org needed

avatar adamchaboryk adamchaboryk - open - 9 Feb 2024
avatar adamchaboryk adamchaboryk - change - 9 Feb 2024
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 9 Feb 2024
Category Administration Language & Strings Repository NPM Change JavaScript Front End Plugins
avatar Fedik
Fedik - comment - 9 Feb 2024

Thanks!
Only thing is left is to fix code style :)
https://ci.joomla.org/joomla/joomla-cms/73378/1/7
It looks like you mixed something with an indents

avatar adamchaboryk adamchaboryk - change - 9 Feb 2024
Labels Added: Feature Language Change NPM Resource Changed PR-5.1-dev
avatar adamchaboryk
adamchaboryk - comment - 9 Feb 2024

Thanks! Only thing is left is to fix code style :) https://ci.joomla.org/joomla/joomla-cms/73378/1/7 It looks like you mixed something with an indents

Well, after an embarrassing number of commits, I think I've made PHPCS happy!

For some reason, this was telling me I had no linting issues:
./libraries/vendor/bin/phpcs --extensions=php -p --standard=ruleset.xml .

Although I'm going to assume I didn't successfully configure the Joomla Coding Standards for PHPCS & VS Code correctly... I'll figure that out later.

Thank you all for your patience!

avatar Fedik
Fedik - comment - 10 Feb 2024

@adamchaboryk I have made a PR to your branch with a couple more fixes adamchaboryk#1

avatar Fedik
Fedik - comment - 12 Feb 2024

@adamchaboryk I made a couple changes and rearrangements to address the backward compatibility, in case when someone use this assets outside of plugin adamchaboryk#2
Restored es5 asset, wich basicaly a dummy, and will be removed later with Joomla 6.

avatar Fedik Fedik - test_item - 12 Feb 2024 - Tested successfully
avatar Fedik
Fedik - comment - 12 Feb 2024

I have tested this item ✅ successfully on 9144751

Works good, thanks!


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

avatar Fedik
Fedik - comment - 13 Feb 2024

@brianteeman please run the test, then we can complete here, I think

avatar brianteeman brianteeman - test_item - 13 Feb 2024 - Tested unsuccessfully
avatar brianteeman
brianteeman - comment - 13 Feb 2024

I have tested this item 🔴 unsuccessfully on 9144751


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

avatar brianteeman brianteeman - alter_testresult - 13 Feb 2024 - brianteeman: Not tested
avatar brianteeman
brianteeman - comment - 13 Feb 2024

In the plugin options if you set "Additional Checks Always On" I would expect that they are always on no matter what the individual settings. Then those checks take place.

Always check for Form Labels, Contrast, Links (Advanced) by default. Enabling this option will visually hide the toggle switches in the Settings panel.

image

But that is not the case. I dont know if its my misunderstanding of the setting or there is a code error.

The only way to check links with the individua settings visually hidden is if you configure it as follows

image

avatar adamchaboryk
adamchaboryk - comment - 13 Feb 2024

In the plugin options if you set "Additional Checks Always On" I would expect that they are always on no matter what the individual settings. Then those checks take place.

This setting just hides the switches/toggles under Sa11y's "Settings" pane. The other toggles in admin settings can turn off those specific checks entirely.

Scenario: Someone may want to check page for all toggleable checks by default, but there website doesn't have any forms, so they turn off the specific "Form Labels" check in Joomla admin settings.

avatar adamchaboryk
adamchaboryk - comment - 13 Feb 2024

Maybe we can brainstorm a new label for "Additional Checks Always On"...

avatar brianteeman
brianteeman - comment - 13 Feb 2024

That is not my understanding of the help text which is in two parts

Always check for Form Labels, Contrast, Links (Advanced) by default.

implies these three checks will always take place

Enabling this option will visually hide the toggle switches in the Settings panel.

implies that the settings are not exposed to the user.

From my understanding of the behaviour that takes place then the help text should be

Enabling this option will visually hide the toggle switches for Form Labels, Contrast, Links (Advanced) in the Settings panel.

avatar adamchaboryk
adamchaboryk - comment - 13 Feb 2024

Enabling this option will visually hide the toggle switches for Form Labels, Contrast, Links (Advanced) in the Settings panel.

Works for me, makes more sense.

avatar brianteeman
brianteeman - comment - 13 Feb 2024

A release lead needs to decide if it is ok to delete all these unused strings r if we must follow previous policy that they should be deprecated instead

avatar Fedik
Fedik - comment - 14 Feb 2024

@adamchaboryk I made another PR for string deprecation adamchaboryk#3
Unfortunatley we cannot just delete them

avatar brianteeman
brianteeman - comment - 14 Feb 2024

will give it a more detailed test tomottow but it looks good to me

avatar brianteeman brianteeman - test_item - 15 Feb 2024 - Tested successfully
avatar brianteeman
brianteeman - comment - 15 Feb 2024

I have tested this item ✅ successfully on 9144751

Thanks Adam


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

avatar Fedik Fedik - change - 16 Feb 2024
Status Pending Ready to Commit
avatar Fedik
Fedik - comment - 16 Feb 2024

r2c


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

avatar LadySolveig LadySolveig - change - 20 Feb 2024
Labels Added: RTC
avatar LadySolveig
LadySolveig - comment - 20 Feb 2024

Added the language strings deprecation also to to the migration section in the documentation

joomla/Manual#223

avatar LadySolveig LadySolveig - change - 20 Feb 2024
Status Ready to Commit Fixed in Code Base
Closed_Date 0000-00-00 00:00:00 2024-02-20 09:25:58
Closed_By LadySolveig
avatar LadySolveig LadySolveig - close - 20 Feb 2024
avatar LadySolveig LadySolveig - merge - 20 Feb 2024
avatar brianteeman
brianteeman - comment - 20 Feb 2024

great -= thanks all

avatar LadySolveig
LadySolveig - comment - 20 Feb 2024

Thank you so much @adamchaboryk for your work and for taking care on the implementation into Joomla and this very nice new features 🚀
I really enjoyed seeing this great collaboration - thanks to everyone for being involved @Fedik @brianteeman @Quy @dgrammatiko

avatar adamchaboryk
adamchaboryk - comment - 20 Feb 2024

Thank you, Martina! I'm super excited for 5.1! I'm also very grateful for all the support and guidance from everyone. Looking forward to future collaborations!

Add a Comment

Login with GitHub to post a comment