Is there any way to render a modal from the theme javascript? I was looking forward to render a modal similar to the one that shows up when changing avatar. Example: api.onPageChange((url, title) => { if (condition) { renderModal; } });

What you need is showModal() and you use it like so First you require show-modal const showModal = require("discourse/lib/show-modal").default; And then use showModal("modalName") // camelCase Then all you have to do is decide how to trigger it. One way to do it is to create a widget and render the modal when it’s clicked like so const showModal = require("discourse/lib/show-modal").default; api.createWidget("modal-button", { tagName: "button.btn.btn-primary", html() { return "Open Modal"; }, click() { showModal("avatarSelector"); } }); This creates a button. When that button is clicked, the avatar selector modal will be displayed. You’d still need to insert that widget somewhere and you have a few options here So, for example this {{mount-widget widget="modal-button"}} Would add the button above topic titles like so [7] While this would open the modal and everything would display nicely, you’d still need to add a few more things to make sure the functionality - like changing the avatar - works as well. I did not include those bits here because this is an example and because I’m not sure I understand what you want to achieve. Can you please share a bit more about what you’re trying to achieve?

Hey Joe, I’m interested by this feature too. I’ve been able to build most of the script using your example but I don’t know how to build a specific modal ? As far as I understand, the showModal thing is loading a template ? Here is what I did : const showModal = require("discourse/lib/show-modal").default; // EvE Online Magic SDE api.decorateCooked(function(cooked){ SDD.LoadMeta() .then(function(arg){ return arg.source.GetTable('invTypes').Load(); }) .then(function(arg){ cooked.find('a[href="#evesde"]').each(function(){ var typeName = $(this).text(); results = _.filter(arg.table.data, function(entry) { return entry[arg.table.c.typeName] === typeName; }); if (results.length > 0) { $(this).attr('data-typeid', results[0][arg.table.c.typeID]); $(this).on('click', function(){ console.debug('show modal'); showModal('eveSdeModal'); }); } }); }); });

Thanks for sharing this example. In this specific scenario, I went with a jQuery solution that proved to be enough. It inspired me for other changes we wanted to do, though.

Hey warlof, As far as I can understand, showModal renders a template from this folder: https://github.com/discourse/discourse/tree/master/app/assets/javascripts/discourse/templates/modal And the name you provide is in CamelCase while the file name is separated by dashes, reason being this: https://github.com/discourse/discourse/blob/master/app/assets/javascripts/discourse/lib/show-modal.js.es6#L44 I hope that helps.

Hum, that’s annoying without getting a plugin but using only the frontend modification. I get that Discourse was using bootstrap as main framework. I’ve been able to use standard modal but I don’t know if it’s the best way to do it (without making a plugin, apparently it is). At least it is working (almost - clicking somewhere else out of the modal isn’t closing it for some reason that I can’t get).

[image] warlof: At least it is working (almost - clicking somewhere else out of the modal isn’t closing it for some reason that I can’t get). For the close I went with a simple jQuery event listener: $("body").on("click", "#badge-modal-close", function() { $(".badge-modal").fadeOut(600); }); Notice that the selector is body because in my example I needed to add html dynamically and this way I don’t need to rebind/add listeners only after.

[image] warlof: I’m interested by this feature too. I’ve been able to build most of the script using your example but I don’t know how to build a specific modal ? Creating a new modal involves 4 steps. 1. creating the template for the modal You can create a new template like so: {{#d-modal-body title="custom_modal_title" class="custom-modal"}} Your content goes here! {{/d-modal-body}} A few quick notes about this: The path you set in data-template-name must start with modal/ followed by your template name {{d-modal-body}} is required The title attribute on {{d-modal-body}} is the title that show at the top of the modal it’s a good idea to add unique classes to your modal 2. Adding a title for the modal If you notice above, the title for {{d-modal-body}} is set to “custom_modal_title” so we need to define what that is and you can do it like so let currentLocale = I18n.currentLocale(); I18n.translations[currentLocale].js.custom_modal_title = "My custom modal"; 3. creating a trigger for the modal For this I’m going to be reusing the method I described in my previous post. Create a widget and show the modal when the widget is clicked but anything equivalent is fine as well. All you need is to get showModal() to fire somehow depending on what you have to work with. const showModal = require("discourse/lib/show-modal").default; api.createWidget("modal-button", { tagName: "button.btn.btn-primary", html() { return "Open Modal"; }, click() { showModal("customModal"); // name is the same you use for the new modal template in camelCase } }); 4. Add the widget to a template somewhere Again, I’ll go back to my previous example and use {{mount-widget widget="modal-button"}} which would add the widget (button) right under the topic title on topic pages. Now all you have to do is put all of this together and add it to the header section of your theme / theme component {{#d-modal-body title="custom_modal_title" class="custom-modal"}} Hello World! {{/d-modal-body}} let currentLocale = I18n.currentLocale(); I18n.translations[currentLocale].js.custom_modal_title = "My custom modal"; const showModal = require("discourse/lib/show-modal").default; api.createWidget("modal-button", { tagName: "button.btn.btn-primary", html() { return "Open Modal"; }, click() { showModal("customModal"); } }); {{mount-widget widget="modal-button"}} and you will have created a custom modal. :+1: I’ve put together a small demo on theme-creator. Just visit any topic page and click on the “open modal” button below the title.

Oh, I figure I had to create files into Discourse to handle the modal templating. Actually I’m doing this by inserting raw bootstrap modal definition : $('#evesde-modal-title').text(data.name) .prepend( $(' ').attr('src', `//image.eveonline.com/Type/${typeID}_32.png`) .attr('alt', data.name) .css('margin-right', '10px')); $('#evesde-modal-description').html(content); $('#evesde-modal').modal('toggle'); After few tests, I assume the transformation have to be applied this way : $('#evesde-modal-title').text(data.name) is becoming I18n.translations[currentLocale].js.eve_sde_modal_title = data.name; $('#evesde-modal').modal('toggle'); is becoming showModal('eveSdeModal'); I don’t know how to update the body dynamically (which have to be raw html) though. I tried to use jquery in order to retrieve the body and update it, but it doesn’t do anything. Also, I have an image to put before the text of the modal header. I don’t figure how to handle this properly neither.

[image] warlof: I don’t know how to update the body dynamically (which have to be raw html) though. I tried to use jquery in order to retrieve the body and update it, but it doesn’t do anything. The reason it doesn’t work is because the modal itself is dynamically loaded. So when your script fires, the element you’re targeting is not in the DOM, and once it is a part of the DOM (when you trigger it with showModal) your script will have already fired. If you want to fire a script when the modal is loaded, you can use the modal:body-shown app event. Here’s a commented example: // when the modal:body-shown event fires, let's try to do some work. we pass the // msg object to try and target a specific modal api.onAppEvent("modal:body-shown", msg => { // let's get the title of the modal from the msg object let title = msg.title; // and compare the current modal's title to see if it has the same title as // the one we want to target. This is the same string you use for the title // attribute you define for the d-modal-body component in your custom modal // template if (title != "custom_modal_title") { // not the modal you want to target return; } else { // this is the one we want, so do your work here $(".modal-body").html("Hey there!"); $('.modal-header').prepend(' Above modal title ') } }); [image] warlof: Also, I have an image to put before the text of the modal header. I don’t figure how to handle this properly neither. just a quick note, when you prepend things to modal-header they will not display correctly right away. This happens because modal-header is set to display: flex. So, you have to play around with its styles a little bit, and even though I don’t understand why you’d want to add an image there it should be possible to prepend an image to the modal header using the same method. [111]

Render modal from theme client-side plugin API

Product Support

Canapin (Coin-coin le Canapin) October 6, 2020, 8:04pm 16

Hi,
I’m showing a modal when we open a forum. Is there a simple way to prevent the modal from closing when we click outside?

Topic		Replies	Views
Render modal for user Product Support	0	349	April 28, 2021
Using the DModal API to render Modal windows (aka popups/dialogs) in Discourse Developer Guides code	0	2357	July 3, 2023
Facebook-style Topic Modal - Is it better? Development	31	1277	August 10, 2026
Dialog modal HTML support UX	11	1045	February 17, 2023
Topic Preview Modal Theme component	81	2311	September 15, 2026

Render modal from theme client-side plugin API

Related topics