How do I properly define a library so that JS will execute after a certain condition is met?

I’m creating a custom module to execute some JS AFTER the cache is cleared. Here is the structure of the module:

Module -> flush.info.yml

name: Flush type: module description: A very important module. package: Custom version: 1.0 core_version_requirement: ^8 || ^9 

Module -> flush.libraries.yml

flush:   version: 1.x   js:     js/flush.js: {}   dependencies:     - core/jquery     - core/drupalSettings 

Module -> flush.module

<?php  use DrupalCoreFormFormStateInterface;  /**  * Implementation of hook_cache_flush()  */    function flush_cache_flush() {     Drupal::state()->set('flush_cache_cleared', TRUE);   }    function flush_page_attachments(array &$attachments) {     if (Drupal::state()->get('flush_cache_cleared')) {       $attachments['#attached']['library'][] = 'flush/flush';      Drupal::state()->set('flush_cache_cleared', FALSE);     }   } 

Module -> JS -> flush.js

(function ($, Drupal, drupalSettings) {     'use strict';      Drupal.behaviors.flush = {       /**        * Drupal attach behavior.        */       attach: function (context, settings) {         this.settings = this.getSettings(settings);         alert("flush!");         console.log ("Hello World");       },     };   })(jQuery, Drupal, drupalSettings); 

Both functions in flush.module work properly, however the JS that is #attached which is simply supposed to use an alert() never runs. I believe the issue is related to this line specifically : $attachments['#attached']['library'][] = 'flush/flush';

Is there something obvious I’m doing wrong? I used page_attachments as the method to attach the JS because it does not necessarily have to be associated with a specific part of the page, or a render array, etc. Please let me know if you have any potential ideas as to what the issue could be, thanks!

This article was republished from its original source.
Call Us: 1(800)730-2416

Pixeldust is a 20-year-old web development agency specializing in Drupal and WordPress and working with clients all over the country. With our best in class capabilities, we work with small businesses and fortune 500 companies alike. Give us a call at 1(800)730-2416 and let’s talk about your project.

FREE Drupal SEO Audit

Test your site below to see which issues need to be fixed. We will fix them and optimize your Drupal site 100% for Google and Bing. (Allow 30-60 seconds to gather data.)

Powered by

How do I properly define a library so that JS will execute after a certain condition is met?

On-Site Drupal SEO Master Setup

We make sure your site is 100% optimized (and stays that way) for the best SEO results.

With Pixeldust On-site (or On-page) SEO we make changes to your site’s structure and performance to make it easier for search engines to see and understand your site’s content. Search engines use algorithms to rank sites by degrees of relevance. Our on-site optimization ensures your site is configured to provide information in a way that meets Google and Bing standards for optimal indexing.

This service includes:

  • Pathauto install and configuration for SEO-friendly URLs.
  • Meta Tags install and configuration with dynamic tokens for meta titles and descriptions for all content types.
  • Install and fix all issues on the SEO checklist module.
  • Install and configure XML sitemap module and submit sitemaps.
  • Install and configure Google Analytics Module.
  • Install and configure Yoast.
  • Install and configure the Advanced Aggregation module to improve performance by minifying and merging CSS and JS.
  • Install and configure Schema.org Metatag.
  • Configure robots.txt.
  • Google Search Console setup snd configuration.
  • Find & Fix H1 tags.
  • Find and fix duplicate/missing meta descriptions.
  • Find and fix duplicate title tags.
  • Improve title, meta tags, and site descriptions.
  • Optimize images for better search engine optimization. Automate where possible.
  • Find and fix the missing alt and title tag for all images. Automate where possible.
  • The project takes 1 week to complete.