Icona Discourse

:discourse2: Summary Discourse Icon allows you to use icons from your SVG icon subset in a post.
:eyeglasses: Preview Preview on Discourse Theme Creator
:hammer_and_wrench: Repository Link https://github.com/discourse/discourse-icon
:open_book: New to Discourse Themes? Beginner’s guide to using Discourse Themes

Install this theme component

Features

Usage:

[wrap=icon id=square][/wrap]

Example:
This is the icon and the icon.

This is the [wrap=icon id=far-square][/wrap] icon and the [wrap=icon id=pencil][/wrap] icon.

Note: if the icon doesn’t show it’s because it’s not in your subset. If you are admin you can add it in your site settings: svg icon subset.


:discourse2: Hosted by us? Theme components are available to use on our Standard, Business, and Enterprise plans.

Last edited by @kelv 2025-04-28T07:23:04Z

Last checked by @Muhammed_EKİCİ 2024-12-02T09:46:54Z

Check documentPerform check on document:
31 Mi Piace

Awesome! This is iconic!

(meta has many many themes, but luckily thanks to @kris.kotlarek we have an add to all themes button… got to sort out progress there, cause it takes a while to do its magic)

13 Mi Piace

Yes didnt want to add to all for now, as I just finished coding it :grin: but will do now

Edit: oh already done

10 Mi Piace

Thanks, that’s super fun! :sunglasses:

I never got into BB script tags, nor have I hand-coded FontAwesome, so the practice of using an empty tag pair has always seemed strange to me. Is that by popular convention, or is there a webcraft reason for using tag pairs? Also, can they have stuff between them, does that affect the text?

3 Mi Piace

There are multiple causes here.

First when I wrote the wrap BBCode feature, @sam explicitly asked to me support 3 formats:

[wrap=foo][/wrap]
[wrap=foo]bar[/wrap]
[wrap=foo]
bar
[/wrap] 

This is done to be consistent with our existing BBCode usage in Discourse.

I could have a better syntax as: [icon=times] but then it would have to be a plugin and not a theme component.

As an experimentation, I think it’s fine as it is today, and if people were to use it a lot, we could think of having a plugin do this with a more concise syntax.

Another idea I have had is to add an API to add autocompletes symbol in the composer just like we have fore users/categories/emojis… But I’m afraid this would be a nightmare with multiple components choosing their own symbol…

5 Mi Piace

Oh! I need to add support for another bbcode and those) thought that I’d use this as a starting point, but you’re saying that the wrap stuff is handled in core, which explains why I can’t find how it’s handled by your theme component.

My current solution is to use the linked words component and an ugly regex, but I’m still struggling to add the necessary classes to the links.

3 Mi Piace

Yes read this topic to know more:

4 Mi Piace

Right I’ve looked at it a dozen times. And printed out the code for your component and stared at it for hours, trying to understand if the degree to which it’s javascript or ember that I don’t understand. I can’t add a [foo] tag without a plugin? Or can I some how replace wrap in your code with foo to cover my new bbcode?

1 Mi Piace

No you can’t. Because part of it is server side. If you want your own custom BBCode you will have to write a plugin and look at how wrap is implemented for example:

https://github.com/discourse/discourse/blob/master/app/assets/javascripts/pretty-text/engines/discourse-markdown/d-wrap.js.es6

5 Mi Piace

Thanks! It’s starting to make sense. I’ve not had this much trouble learning a new language since C++ and objective Pascal in 1990.

My current regex hack almost works. I’ll need to decide whether to go the plugin route or stick with my hack (and figure out how to add the classes).

At least now I understand why I can’t find that wrap in the theme component!

3 Mi Piace

I can think of a few possible syntax layouts to add to the wrap plugin for this:

[wrap=foo /]
[wrap/=foo]

(mimicing XML’s self-closing tags) but those are both fairly ugly :confused:

Anyone got amazing ideas for something that looks okay?

3 Mi Piace

yeh not a big fan of these :confused:

6 Mi Piace

Ho trovato un grosso bug…

Se si utilizza un wrapper di icone e quindi si evidenzia la citazione, l’immagine risultante viene enormemente ingrandita:

  • Utilizzare un wrapper di icone in una frase in un post. es. Questo è un'icona [wrap=icon id=far-check-square][/wrap]
  • Evidenziare il testo pertinente e ‘Cita’
  • L’icona diventa super grande nell’estratto citato

Questo è l’aspetto della sintassi quando viene evidenziata e citata:

[quote="JammyDodger, post:1, topic:294, full:true"]
This is an icon ![](/svg-sprite/grumpy.jammydodger.monster/icon/222222/far-check-square.svg)
[/quote]

Questa è una risposta in cui diventa enorme

Tuttavia, citarla usando la bolla di dialogo nella barra del formato funziona bene.

4 Mi Piace

Come riesci a evidenziare l’icona della citazione? Sul mio sito di prova, l’icona viene saltata.

Non sono sicuro? Uso solo il mouse.

Che browser stai usando?

Usando il mouse, ho provato con Chrome e Firefox e non sono riuscito a selezionare l’icona. :thinking:


MODIFICA:

Se racchiudi un’icona non disponibile nel sottoinsieme corrente, creerà invece un’immagine SVG.
Quindi, puoi citarla.

1 Mi Piace

Puoi fornire un esempio? Il tuo screenshot mostra una casella di controllo selezionata e non ho problemi a selezionarla nella mia istanza di test (cosĂŹ come altre icone probabilmente non utilizzate da Discourse come x-ray).

1 Mi Piace

Vedo il problema. Il componente cerca controllando se c’è un wrapper con la classe d-wrap; ma non c’è alcun wrapper se l’icona fornita non proviene dal sottoinsieme. Crea invece un’immagine come SVG.

Ad esempio:

SVG, icona all'interno del sottoinsieme

Immagine come SVG, icona non all'interno del sottoinsieme

Se citi le immagini, il componente non fa nulla, poiché non c’è alcun wrapper (e l’immagine viene convertita in markdown, risultando in un’immagine senza alcuna classe)

1 Mi Piace

Questo significa che devo avere un campo svg_icons in settings.yml disponibile nel mio tema? Oppure potrei usare qualsiasi campo svg_icons disponibile da qualsiasi componente tema abilitato? E in tal caso, avrebbe senso aggiungere questo campo a questo componente tema?

svg_icons:
  default: ''
  type: 'list'
  list_type: 'compact'

PerchĂŠ nella mia esperienza, le icone SVG vengono trasformate in tag <img /> e non ereditano currentColor quando lo schema di colori viene modificato:
Confronta il paragrafo Esempio:

2 Mi Piace

È possibile migliorare il rendering in modalità scura?

Mi piacerebbe avere gli stessi colori dell’interfaccia:

3 Mi Piace