类别横幅

[Discourse]

	摘要	类别横幅 利用现有的类别详细信息为您的类别页面创建横幅（如需查看标签，请访问 Discourse 标签横幅）。
	预览	在 Discourse 主题创建器中预览
	仓库链接	https://github.com/discourse/discourse-category-banners
	Discourse 主题新手？	使用 Discourse 主题的入门指南

安装此主题组件

由于这是由 Discourse 团队维护的 official 主题组件，因此 #support、#bug、ux 和 #feature 请求可以在 Meta 上的相应类别中提出，并打上相应的主题组件标签。点击下方链接即可开始。: +1:

 支持  Bug  用户体验  功能

功能

类别横幅 利用现有的类别详细信息为您的类别页面创建横幅。它使用类别名称、描述和颜色在相关类别页面的顶部生成横幅（如需查看标签，请访问 Discourse 标签横幅）。

类别描述由每个类别的“关于此类别的…主题”中的第一段定义。横幅背景/文本颜色由您的类别徽章设置定义。

默认情况下，这将在桌面端和移动端的各类别和子类别页面上显示，但如果您未为类别提供描述，则不会显示。

设置

此组件提供了一些选项以覆盖默认设置：

名称	描述
show description	显示“关于此类别”帖子中的描述
show mobile	在移动设备上显示横幅
show subcategory	为子类别显示横幅
hide if no description	如果未设置类别描述，则隐藏横幅
show category logo	显示类别徽标
align text	对齐文本
exceptions	横幅不会显示在这些类别名称中
categories	为其显示横幅的类别
plugin outlet	更改横幅在页面上的位置
show category icon	显示类别设置中的类别图标或表情符号 *
override category icon color	当使用类别图标时，启用此选项将使图标与横幅文本颜色匹配

• 请注意，此设置现在指的是 在类别设置中设置的类别图标或表情符号，而不是 类别图标 主题组件（该组件已弃用，推荐使用核心功能）。

自定义说明

如果您想使用一些额外的 CSS 进行自定义，可以通过以下结构针对特定的类别标题（example-category 是您的类别名称）：

.category-title-header {
  &.category-banner-example-category {
        background: url(example.jpg);
  }
}

此组件还会向 body 标签添加 category-header 类，作为额外的 CSS 目标。

由我们托管？ 主题组件可在我们的标准版、商业版和企业版计划中使用。

[Pad_Pors]

thanks for this wonderful theme , it helps users to note the category description much easier.

currently if there’s a link or a bold/italic word in the category description, in the banner it’ll appear as simple text (e.x. p style instead of a style). isn’t it better if the text style is preserved in the banner as well?

[jimmymckinney (Jimmy)]

Hi, I absolutely love this component! Thanks for your work!

I’m wondering, how can I style the background so that it automatically pulls the category background image and makes it the background of the banner. The backgrounds are already hidden anyways, so I want it to simply display as the background to the banner, rather than the page. I’ve tried this, but it didn’t work and I think I might be targeting the wrong variable:

return h('div.category-title-header' + " ." + category.slug, {
                    "attributes" : {
                        "style" : "background-color: #" + category.color + "; color: #" + category.text_color + "; background-image: url(\'" + 
                        category.background_url + "\');"
                    }
                }

Also, I’m wondering, how can I make the banner thinner for a fixed width design. When I attempted, it continued to be left-justified.

[jrgong]

I think it’s great that the category banners now render content in HTML.

Is there any way to display emojis there? In my case, I added three important links: Anfänger - Forum | Cannabisanbauen.net

I want to display the emojis next to each link as well. The original about topic is here: Über die Kategorie Anfänger - Anfänger - Forum | Cannabisanbauen.net

[awesomerobot (Kris)]

Not prefixing the category name is a recipe for disaster, so I’ve added category-banner- before the class name (e.g., category-banner-meta). If you were targeting the category name in your CSS you’ll just have to add category-banner- before it.

@jrgong

Is there any way to display emoji’s there?

I’m not sure, I don’t think our default category descriptions support them either, but I can look into it…

[Hang]

I want to use the uploaded background image from the category to put it in the background of the banner. I’ve edited the code and everything looks great. I wonder is there anything I can do to make the image load faster or together with the rest of the page? I want to avoid the flickering of the background for a second before the image appears.
Compressing image is certainly an option, but I wonder if there are others. Can I grab the thumbnail of the uploaded background image in the code? Thanks for all leads!

[Vanecx]

Hello, and thank you for this theme component!

I just tried installing it, following this tutorial (did exactly the same steps) to try this Category Banners component, but nothing happens. No banner in any of the categories. Is there anything that I might have done that doesn’t make it work? The only explanation I see is that the “bootstrap” warning blocks it?

[simon]

@Vanecx

No banner in any of the categories. Is there anything that I might have done that doesn’t make it work?

By default, the theme component does not display category banners if you have not set a category description for a category. This can be changed by unchecking the “Hide banners if category description not set” checkbox.

Category descriptions are set by editing the About category topic that Discourse automatically creates for every category. If you have either added category descriptions, or disabled the setting to hide banners for categories without descriptions, and you are still not seeing category banners, let us know. We’ll look into what is going on.

[Vanecx]

Thank you for your answer. I have checked and confirm that each category on the forum has a description. The “Hide banners…” option is now unchecked just to make sure but nothing changes.

As you can see on the images, everything looks normal in the settings :

No idea if it could have anything to do with the issue but just informing you it’s a Discourse installation on a Yunohost instance.

[downey (Michael Downey)]

Is there anyone other than me that thinks it would be nice to enable this same styling on Group listing pages (e.g. /g/foo) as well? The CSS, unfortunately, is not quite the same, and I guess it would require some additional handling of the various buttons to the right side of the group name, i.e., Request Message Delete

It could go a long way for a consistent look and feel, and make groups feel more like a “first class” citizen among the UI. (IMHO)

[jord8on (Jordan)]

I love these category banners! Thank you for making this theme component!

I would love this banner to exist in the main home page of our forums where it shows:

• “Latest” Discussions or
• “Top” Discussions or
• “Categories” or
• “Following” (if you’re using the Follow Plugin )

Would there be an easy (ish) way to have there be a banner if someone selected each of these options, respective to what was selected?

[Rhidian (Rhidian Bramley)]

@awesomerobot , I hope you are okay with me sharing this here…

I’ve created a fork of this discourse-category-banners theme called

discourse-category-banner-boxes
https://github.com/naidihr/discourse-category-banner-boxes

You can preview it here

https://theme-creator.discourse.org/theme/Rhidian/discourse-category-banner-boxes

It pretty much does the same thing but with some modifications:

• The category banner box is displayed in-line above the main heading instead of full width at the top. This allows for display a banner theme at the top, for example the discourse-versatile-banner.

• The category banner box is displayed in the same style as the native discourse subcategory boxes, which are a core component of discourse. These subcategory boxes are a display option in the discourse category settings Show subcategory list above topics in this category . This option displays the subcategory category name and description as a row or box above the topic list, using the category background colour as the left border.

• If the category is a subcategory, the category name is displayed as breadcrumb as follows - Parent category name: Subcategory name

Demo screen shot of theme banner box for the category, above the native subcategory boxes.

Screen shot of the subcategory, showing the breadcrumb reference to the parent category.

This is my first attempt at a theme modification. I hope this is helpful?

Update

I have refactored this adaption as a separate component - with many additional features including using the category logo image and background image in the header. This new component effectively replaces the standard Discourse category header, unlike the category banners, hence making it a new component. Please see:

Discourse Category Headers theme component

This theme component provides a number of enhancements for the Discourse category header. The ‘standard’ Discourse category header is displayed at the top of each category page, above the navigation links and list of topics. It is normally only visible if a category logo image has been uploaded in the category settings. The header displays the logo and a short description of the category, taken from the first paragraph of the ‘About the.. category’ topic. This theme component provides the foll…

[nathank (Nathan Kershaw)]

@awesomerobot

Exceptions : if you don’t want a category to have a banner, add its name here

This isn’t working for us. I’ve tried both the category slug and the category ID, but the banner stays stubbornly there. Is this working for anyone else?

[awesomerobot (Kris)]

I just tried it and it works for me, it’s looking for the case-sensitive category name. In retrospect that was not the best way to implement it… I can probably improve that.

[nathank (Nathan Kershaw)]

Ah - that sort is for me! And you do state ‘name’ in the guide above - I just didn’t read that.

Name isn’t very intuitive as we don’t really use it for anything else. But it is displayed a lot. Just making it more explicit in the settings would be fine I reckon.

[AntiMetaman]

Instead of adding exceptions of what which categories will not show a given uploaded banner, can’t we just specify which category should show which banner?

[awesomerobot (Kris)]

Depends on the specific site and use-case I’m sure. My initial thought was that it would be more likely for a site to want it implemented everywhere, and if there were exceptions it would only be a few.

If you wanted to implement a banner for a small number of categories there might be a better theme component option that’s built to be a less generic cover-all, like Versatile Banner or customizing one of the options found in Banner themes (and instructions for customizing them)

[Idan]

如果能上传图片来替换文字就太好了。

[oca]

感谢这个非常有用的组件！

能否添加一个小功能？

• 当分类不是公开时，为 <span.discourse-category-banners> 或 <div.category-title-header> 元素添加 restricted 类，就像分类徽章那样处理。

这将有助于通过额外的 CSS 调整横幅，向用户表明该分类是特殊的。

目前虽然可以实现，但用 CSS 选择锁图标并进行操作相当复杂。由于 CSS 没有父选择器，我无法利用锁图标的存在来判断是否应修改横幅。

我还不太熟悉如何提交 PR，但如果你们愿意接受我的修改，这将是我学习的好机会。

[Drew-ART (Drew)]

这个功能能否在标签页上实现？我找到了 tag-banners 插件，但它无法添加文本或链接。