Settings not appearing

Development
1

Hi everyone, I’m getting started on developing things for Discourse, and I’m working on a theme component.
Link: GitHub - NateDhaliwal/discourse-persistent-banner: A theme component for Discourse that cannot be closed by the user. · GitHub

When putting it on Theme Creator, the settings don’t appear, even though I have a settings.yml. Any ideas?

2

Do you see any error messages at theme creator?

I think you have to use the same quotation marks at the beginning and end.

This could also be a problem. I would try default: ""

Maybe you want to add “block” to the choices. Otherwise you have to use the revert button to choose that again.

3

Whoops, just realised I was clicking on ‘Create new’ instead of importing it…
But now, when I try using the URL, it says that about.json is invalid or doesn’t exist, asking me if it is a theme.
About.json:

Is there something wrong?

4

Missing comma after license URL.

5

:roll_eyes:
@merefield Would version be in ""?

6

Probably that too. Just look at examples.

7

Thanks! One last one, I can’t seem to get the variable to display.
https://github.com/NateDhaliwal/discourse-persistent-banner/blob/main/common/header.html

Was it because I didn’t initialise it properly? I tried following the guide…

8
  1. don’t use “header.html”, use a proper component (preferably a .gjs file, but .hbs might suffice).
  2. use html-safe helper whenever outputting html from settings or variables.
9

Would I have to use

import Component from "@glimmer/component";

export default class PracticeComponent extends Component {
  get bannerLinks() {
    return JSON.parse(settings.banner_links);
  }
}

then?

10

Look at the billions of examples :stuck_out_tongue_winking_eye:

11

You only need to use a gjs file if you need to process stuff with javascript, otherwise an hbs template file might suffice. Experiment.

12

I’m not sure if I’m going in the right direction.
I made javascripts/persistent-banner.hbs with this:
https://github.com/NateDhaliwal/discourse-persistent-banner/blob/main/javascripts/persistent-banner.hbs

But nothing shows up. Tried putting it in different places, still won’t work.

Tried looking at example, but many don’t seem to help.
Any advice?

13

In which plugin outlet do you want to put your banner?
Take a look at Using Plugin Outlet Connectors from a Theme or Plugin

You could use https://meta.discourse.org/t/add-a-featured-topic-list-to-your-discourse-homepage/132949?u=moin as an example

You can use the (deprecated) Plugin outlet locations theme component to find the names and locations of the plugin outlets. “above-main-container” for example is the top one above the topic list, but not above the sidebar.

image
image1394×583 41.2 KB

Looking at the code of a #theme-component which adds something similar is also a great way to learn.

14

You do not need and should not put script tags in hbs files. They should be limited to the content of the template.

Don’t stab in the dark, read the guides:

15

So… I managed to get it working without using a hbs file, but instead using the <script> tag with handlebars, and it now works.
I use it like this for now, but I’ll continue to try using a hbs file instead.

16

created a quick pull request for you so you can see the way to split up the files properly. feel free to merge or just have a look at the branch.

https://github.com/NateDhaliwal/discourse-persistent-banner/pull/3

17

Thanks so much! It works now!

18

No worries Nate. Keep up the experimenting, reading and looking at other examples. In no time you’ll be much better than I am at this dev stuff :smiley: :raised_hands:

19

Thanks for the encouragement!