We have a js function that runs on DOMContentLoaded, document.addEventListener(“DOMContentLoaded”, OURFUNCTION). It works fine when you refresh the browser, but never shows when you navigate the site. I presume that’s because Discourse only loads the dom once and then the rest of handled with client side navigation, like an SPA. Some I’m wondering, how can we run the function on a navigation change in Discourse itself? There used to be easy ways to do that via the plugin API, but those APIs are deprecated and I don’t see them used anymore in any components. Is there an easy way to still do this? Or do we need to make a whole component to just execute some JavaScript upon a navigation change? THanks.

Hey, If you’re looking for an event called when page loads, there is api.onPageChange. api.onPageChange((url, title) => { console.log('the page changed to: ' + url + ' and title ' + title); }); If you’re looking for something else, can you elaborate on what you want to achieve? We could give you a more precise answer. On a side note, you have a ton of documentation that you might find helpful: Developer Guides - Discourse Meta.

Hmmm … I’m not sure it guarantees the DOM content has loaded, I believe it fires on the Route change, which is much earlier. You’d need to consider attaching a Component to a Plugin Outlet and firing on didInsert modifier if the DOM loading is important. If just the Route change is important, then yes, onPageChange should do it :+1:

You may be right! :thinking: onPageChange is called the next runloop, so I think it will still be called after DOMContentLoaded in most situations, but I can’t say it’s guaranteed. I can see usage relying on onPageChange and doing DOM element stuff directly. From where is fired the routeDidChange event btw (EDIT: it’s from ember: RouterService | 6.12.0 | Ember API Documentation)? I agree with the didInsert modifier, really neat!

Thanks. I’ve read thru the documentation extensively and per my comments and a discourse member follow up there, the plugin API is legacy and will be deprecated soon. So while your code might work now, it will break soon, I believe in future updates. That’s why I’m looking for a better solution. Seems overkill to create a glimmer component for this so I was hoping there was another event that maybe we could use.

[image] DDSGadget: the plugin API is legacy and will be deprecated soon I don’t believe that is correct. [image] Using the JS API Developer Guides Discourse’s JavaScript API allows themes and plugins to make extensive customizations to the user experience. The simplest way to use it is to create a new theme from the admin panel, click “Edit Code”, and then head to the JS tab. For file-based themes, the API can be used by creating a file in the api-initializers directory. For theme’s that’s {theme}/javascripts/api-initializers/init-theme.gjs, and for plugins, it’s {plugin}/assets/javascripts/discourse/api-initializers/init-plugin.js. The c… was updated last week. What is deprecated are: widget API Raw templates Overriding templates in general

Thanks for clarifying! So it’s just the widget api . Ok will try the api suggestions above first

[image] DDSGadget: it’s just the widget api This is kind of a blessing :sweat_smile:, Glimmer is a helluva lot more developer friendly

BTW, we tested it with api.OnPageChange and it works fine. We haven’t run into an instance yet here the DOM content wasn’t available upon calling OnPageChange, so it seems like it is fired after DomContentLoaded. But, I can’t be 100% sure. Thanks for your help on this.

Good. Just be aware that timing is not guaranteed. But glad it works for your use case!

How to get around DOMContentLoaded for navigation?

Development

ddsgad (DDSGadget) February 21, 2025, 3:00pm 11

Can you please better explain what this means? What is the didInsert modifier? I’m firing on the decorateCookedElement. Thanks.

Topic		Replies	Views
[newbie] Trouble adding script to dynamically change CSS values based on conditions Product Support	9	1853	October 11, 2016
Trigger javascript on clicking any page link, but before the page content loads? Development	10	1440	November 4, 2024
Executing js after DOM loaded Product Support	6	3843	November 30, 2018
My plugin codes runs just once!(My own script shouldn't be cached) Development	17	2571	November 21, 2016
beforePageChange plugin API? Development	1	657	December 15, 2021

How to get around DOMContentLoaded for navigation?

Related topics