Ícone do 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 curtidas

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 curtidas

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 curtidas

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 curtidas

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 curtidas

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 curtidas

Yes read this topic to know more:

4 curtidas

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 curtida

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 curtidas

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 curtidas

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 curtidas

yeh not a big fan of these :confused:

6 curtidas

Encontrei um grande bug…

Se você usar um wrapper de ícone e depois destacar a citação, a imagem resultante fica enormemente ampliada:

  • Use um wrapper de ícone em uma frase em uma postagem. Ex: Este é um ícone [wrap=icon id=far-check-square][/wrap]
  • Destaque o texto relevante e ‘Cite’
  • O ícone fica super grande na citação em destaque

Esta é a aparência da sintaxe quando a citação é destacada:

[quote="JammyDodger, post:1, topic:294, full:true"]
Este é um ícone ![](/svg-sprite/grumpy.jammydodger.monster/icon/222222/far-check-square.svg)
[/quote]

Esta é uma resposta onde ele fica enorme

Embora citá-lo usando a bolha de fala na barra de formato funcione bem.

4 curtidas

Como você consegue destacar o ícone da citação? No meu site de teste, o ícone é ignorado.

Não tenho certeza? Eu apenas uso o mouse.

Qual navegador você está usando?

Usando o mouse, testei com Chrome e Firefox e não consegui selecionar o ícone. :thinking:


EDIT:

Se você encapsular um ícone indisponível no subconjunto atual, ele criará uma imagem SVG em vez disso.
Então, você pode citá-lo.

1 curtida

Você pode fornecer um exemplo? Sua captura de tela mostra uma caixa de seleção marcada e não tenho problemas em selecioná-la em minha instância de teste (bem como outros ícones que provavelmente não são usados pelo Discourse, como x-ray.

1 curtida

Eu vejo o problema. O componente pesquisa verificando se há um wrapper com a classe d-wrap; mas não há wrapper se o ícone fornecido não for do subconjunto. Ele cria uma imagem como SVG em vez disso.

Por exemplo:

SVG, ícone dentro do subconjunto

Imagem como SVG, ícone não dentro do subconjunto

Se você citar as imagens, o componente não faz nada, pois não há wrapper (e a imagem é convertida para markdown, resultando em uma imagem sem nenhuma classe)

1 curtida

Isso significa que preciso ter um campo svg_icons em settings.yml disponível no meu tema? Ou eu poderia usar qualquer campo svg_icons disponível em qualquer componente de tema habilitado também? E se for esse o caso, faria sentido adicionar este campo a este componente de tema?

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

Porque na minha experiência, os ícones SVG são transformados em tags <img />, e eles não herdam currentColor quando o esquema de cores é alterado:
Por favor, compare o parágrafo Exemplo:

2 curtidas

A renderização no modo escuro poderia ser aprimorada?

Gostaria de ter as mesmas cores da interface:

3 curtidas