Introducing Font Awesome 5 and SVG icons

cpradio · December 24, 2018, 2:47am

I disagree. You can simply create a copy of your theme, remove the script tag, click preview and see what broke. The rest of your members see a functional site as you work to resolve the issues. This gives them the impression of stability while you are only aware of the underlying issues at hand.

I spent more time than I’d like to admit to fix our instance (SP) which is hosted, it was definitely more than 1-2 hours and some of the fixes were not obvious. In some places you had to set width and heights both on the object and in the svg, along with figuring out coloring, etc. It took time. Sure I got it done, but I also used a “preview” theme to ensure I didn’t make the experience worse for anyone else in the meantime.

codinghorror · December 24, 2018, 2:51am

As long as it is really a temporary fix, that’s fine. This did not come across to me in your original post, though.

sarahann · January 10, 2019, 7:28pm

Using icons in your handlebars templates

Is there any way to specify the size of the icon in the handlebars code (eg: size=‘2x’ )? or should we do this in CSS?

pmusaraj · January 10, 2019, 7:39pm

You would have to specify the size in CSS. The d-icon helper can take a title parameter, but not a style or size parameter.

sarahann · January 10, 2019, 7:44pm

Wonderful! thanks so much

sarahann · January 11, 2019, 1:09am

I was hoping to replace a Discourse icon with a custom one. Would there be a way to register my custom icon in Discourse somewhere? ie)

register_svg_icon “my-icon” as <svg>...</svg>

then be able to

api.replaceIcon(‘heart’, ‘my-icon’);

pmusaraj · January 11, 2019, 2:08am

That’s a nice idea, we should support adding a custom icon in this fashion. We currently don’t. I’m going to look into it in more detail in the next few days.

pmusaraj · January 12, 2019, 3:32pm

Ok, adding custom icons in a plugin should now be doable as of
https://github.com/discourse/discourse/commit/47cbfb14989bcf828c66b211827cb9355214e71a

So, basically, add the SVG sprites to your plugin, in plugins/svg-icons. See https://raw.githubusercontent.com/discourse/discourse/master/vendor/assets/svg-icons/discourse-additional.svg for an example. Next, register your icon, and you should be good to go.

(I would prefix the icon ids in the plugin, to avoid any potential clash with FontAwesome icon names.)

jimmyfc23 · January 19, 2019, 6:18am

Just thought I’d post how I got these working with html after reading closely through the thread. (I would say in future to let everyone know in the original thread about the new system settings to get icons going on headers etc).

To add some icons go to /admin/site_settings/category/all_results?filter=icons and add the prefixes accordingly. “Add additional FontAwesome 5 icons that you would like to include in your assets. Use prefix ‘fa-’ for solid icons, ‘far-’ for regular icons and ‘fab-’ for brand icons.”

Eg fa-newspaper.

Then reference them in your html. Eg <svg class="fa d-icon d-icon-newspaper svg-icon svg-node" aria-hidden="true"><use xlink:href="#newspaper"></use></svg>.

Mark_Schmucker · January 21, 2019, 8:43am

tshenry:

Hey @LKNickname, try this out:

const { iconNode } = require("discourse-common/lib/icon-library");
api.decorateWidget("header-icons:before", helper => {
  return helper.h("li", [
    helper.h(
      "a#globe-button.icon",
      {
        href: "https://www.website.com/",
        title: "Back to website"
      },
      iconNode("globe")
    )
  ]);
});

That worked so well I’d like to add a second button. I naively tried:

<script type="text/discourse-plugin" version="0.4">
const { iconNode } = require("discourse-common/lib/icon-library");
api.decorateWidget('header-icons:before', helper => {
    return helper.h('li',
      [
        helper.h('a#home-button.icon', {
            href:'https://docs.google.com/spreadsheets',
            title: 'Spreadsheet'
        }, iconNode('table')),
        helper.h('a#home-button.icon', {
            href:'https://google.com',
            title: 'Google'
        }, iconNode('globe')),
      ]
    );
});
</script>

But that gave a weird alignment:

How can I make the globe vertically aligned with the rest of the buttons?

Dax · January 21, 2019, 8:50am

There is a well-maintained theme component to use that is already updated to works with FA5 and that add more than 1 button before the header icons:

TerminalAddict · February 3, 2019, 8:11pm

Can I have some help?
I have previous registered a couple of extra icons:

api.decorateWidget('header-icons:before', helper => {
    return [
        helper.h('li', [
            helper.h('a#home-button.icon', {
                href: '/',
                title: 'McRides Home'
            }, helper.h('i.fa.fa-home.home-button-icon.d-icon')),
        ]),
                helper.h('li', [
            helper.h('a#weather-button.icon', {
                href: 'https://www.mcrides.co.nz/t/weather-forecast/77',
                title: 'Weather Forecast'
            }, helper.h('i.fa.fa-cloud.weather-button-icon.d-icon')),
        ])
    ];
});

I can see in this thread how I would redo this (or I’m not that skilled probably this )

Steven · February 3, 2019, 9:16pm

The theme component introduced just before will help you do it really easily

But if you really want to do it manually, the first post of this #howto will help

TerminalAddict · February 4, 2019, 1:21am

how do i
add the icon to the svg icon subset site setting

Here’s what I’ve got:

api.decorateWidget('header-icons:before', helper => {
    return [
        helper.h('li', [
            helper.h('a#home-button.icon', {
                href: '/',
                title: 'McRides Home'
            }, iconNode('home')),
        ]),
        helper.h('li', [
            helper.h('a#weather-button.icon', {
                href: 'https://www.mcrides.co.nz/t/weather-forecast/77',
                title: 'Weather Forecast'
            }, iconNode('cloud-sun')),
        ])
    ];
});

the home icon works, the cloud-sun (I also tried cloud) doesn’t

Steven · February 4, 2019, 1:58am

Search for the setting svg icon and type the name of the icon with the right prefix

fa-cloud or fa-cloud-sun and it should work after a refresh of the page

meetdilip · February 4, 2019, 5:16am

Does this mean that Discourse still ships with Font Awesome even though it uses SVG icons ?

codinghorror · February 4, 2019, 5:45am

Font Awesome is itself SVG in V5

meetdilip · February 4, 2019, 6:03am

So v 2.2 does come with FA pre loaded ? I thought you skipped it for its size.

vinothkannans · February 4, 2019, 6:44am

You should check our release topic to know more about included features in version 2.2. Also the blog post.

meetdilip · February 4, 2019, 7:41am

I read it. It says about dropping the font icon.

We’ve also fully converted to SVG icons instead of relying on a font icon. This is more efficient than shipping a giant and mostly unused icon font. Plus, it’s now much easier to switch any visible icon in Discourse with something else, even a completely custom one-off glyph that you created.

svg-replace-any-glyph-discourse-22.png1146×196 28.8 KB

Prefer to use your custom logo instead of the default like heart? Make it so!