Contrib.social

Refactor (if feasible) uses of the jQuery toggle function to use vanillaJS

Open on Drupal.org →
Created on 24 September 2021, about 3 years ago
Updated 10 April 2024, 9 months ago

Problem/Motivation

As mentioned in the parent issue #3238306: [META] Where possible, refactor existing jQuery uses to vanillaJS to reduce jQuery footprint → , we are working towards reducing our jQuery footprint. One of the ways to accomplish this is to reduce the number of jQuery features used in Drupal core. We have added eslint rules that identify specific features and fail tests when those features are in use.

There are (or will be) individual issues for each jQuery-use eslint rule. This one is specific to jquery/no-toggle, which targets the jQuery toggle function.

Steps to reproduce

Proposed resolution

Remaining tasks

  • In core/.eslintrc.jquery.json Change "jquery/no-toggle": 0, to "jquery/no-toggle": 2, to enable eslint checks for uses of jQuery .toggle(). With this change, you'll be able to see uses of the undesirable jQuery feature by running yarn lint:core-js-passing from the core directory
  • Add the following lines to core/scripts/dev/commit-code-check.sh so the DrupalCI testing script can catch this jQuery usage on all files, not just those which have changed
    # @todo Remove the next chunk of lines before committing. This script only lints
#  JavaScript files that have changed, so we add this to check all files for
#  jQuery-specific lint errors.
cd "$TOP_LEVEL/core"
node ./node_modules/eslint/bin/eslint.js --quiet --config=.eslintrc.passing.json .

CORRECTJQS=$?
if [ "$CORRECTJQS" -ne "0" ]; then
  # No need to write any output the node command will do this for us.
  printf "${red}FAILURE ${reset}: unsupported jQuery usage. See errors above."
  STATUS=1
  FINAL_STATUS=1
fi
cd $TOP_LEVEL
# @todo end lines to remove

    Add the block about 10 lines before the end of the file, just before if [[ "$FINAL_STATUS" == "1" ]] && [[ "$DRUPALCI" == "1" ]]; then, then remove it once all the jQuery uses have been refactored.

  • If it's determined to be feasible, refactor those uses of jQuery .toggle() to use Vanilla (native) JavaScript instead.

User interface changes

API changes

Data model changes

Release notes snippet

📌 Task
Status

Postponed

Version

11.0 🔥

Component
Javascript  →

Last updated 3 days ago

Created by

🇺🇸United States hooroomoo

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • First commit to issue fork.
  • Merge request !5972refactored jquery toggle → (Open) created by omkar-pd
  • Status changed to Needs review 12 months ago
  • Comment 12 months ago →
    🇮🇳India omkar-pd

    Refactored jQuery toggle to JS. Tests are passed. Moving this to Needs Review.

  • Status changed to Postponed 12 months ago
  • Comment 12 months ago →
    🇫🇷France nod_ Lille

    The replacements do not look straightforward, an intermediate method could be used to make is nicer and handle the various edge cases we're most likely missing, but at that point why not just use jQuery itself?

    I'm on the fence here, I'd go with leaving that as-is and revisiting once we're closer to removing jquery.

  • First commit to issue fork.
contrib.social Blog FAQ Discussions
Production build 0.71.5 2024