Banners de categoría

[Discourse]

	Resumen	Category Banners utiliza los detalles existentes de las categorías para crear banners para tus páginas de categoría (para etiquetas, consulta Discourse Tag Banners).
	Vista previa	Vista previa en Discourse Theme Creator
	Enlace al repositorio	https://github.com/discourse/discourse-category-banners
	¿Nuevo en los temas de Discourse?	Guía para principiantes sobre el uso de los temas de Discourse

Instalar este componente de tema

Dado que este es un #componente de tema #oficial mantenido por el equipo de Discourse, las solicitudes de #soporte, bug, ux y #funcionalidad pueden realizarse en las categorías correspondientes aquí en Meta, y etiquetarse con la etiqueta del componente de tema apropiada. Haz clic en un enlace a continuación para iniciar uno.

 Soporte  Error  UX  Funcionalidad

Características

Category Banners utiliza los detalles existentes de las categorías para crear banners para tus páginas de categoría. Utiliza el nombre, la descripción y el color de la categoría para generar un banner en la parte superior de las páginas de categoría relevantes (para etiquetas, consulta Discourse Tag Banners).

La descripción de la categoría se define mediante el primer párrafo del tema “Definición de categoría para …” de cada categoría. Los colores de fondo y texto del banner se definen mediante la configuración de insignias de tu categoría.

De forma predeterminada, esto se mostrará en escritorio y móvil en todas las páginas de Categoría y Subcategoría, pero no aparecerá si no has asignado una descripción a tu categoría.

Configuración

Este componente viene con opciones para anular los valores predeterminados:

Nombre	Descripción
mostrar descripción	Mostrar descripción del tema “Acerca de esta categoría”
mostrar móvil	Mostrar banners en móvil
mostrar subcategoría	Mostrar banners para subcategorías
ocultar si no hay descripción	Ocultar banners si no se ha establecido la descripción de la categoría
mostrar logotipo de categoría	Mostrar logotipo de categoría
alinear texto
excepciones	El banner no se mostrará para estos NOMBRES de categoría
categorías	Categorías para las que mostrar un banner
plugin outlet	Cambia la posición del banner en la página
mostrar icono de categoría	Mostrar icono o emoji de categoría desde la configuración de la categoría *
anular color del icono de categoría	Cuando se utilizan los iconos de categoría, activar esto hará que el icono coincida con el color del texto del banner

• Ten en cuenta que esta configuración ahora se refiere al icono o emoji de categoría establecido en la configuración de la categoría, no al componente de tema Iconos de categoría (que está obsoleto en favor de la función principal).

Notas de personalización

Si deseas personalizarlos con algo de CSS adicional, puedes dirigirse a encabezados de categoría específicos utilizando esta estructura (ejemplo-categoría es el nombre de tu categoría):

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

Este componente también añade la clase category-header a la etiqueta body como un objetivo CSS adicional.

¿Alojado por nosotros? Los componentes de tema están disponibles para su uso en nuestros planes Estándar, Empresarial y Corporativo.

[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]

Sería genial poder subir una imagen para reemplazar el texto.

[oca]

¡Gracias por ese componente muy útil!

¿Sería posible añadir una pequeña función?

• Añadir la clase restricted al elemento <span.discourse-category-banners> o <div.category-title-header> cuando la categoría no sea pública, de la misma manera que se hace con la insignia de la categoría.

Sería útil para ajustar el banner con CSS adicional y mostrar al usuario que esta categoría es especial.

Por ahora, es posible hacerlo, pero resulta complicado seleccionar el icono de candado con CSS y realizar ciertas acciones, ya que CSS no tiene selector de padre, por lo que no puedo usar la presencia del icono de candado para verificar si el banner debe modificarse.

Aún no sé muy bien cómo hacer PRs, pero usaría esto como una buena razón para aprender si estás abierto a mi modificación.

[Drew-ART (Drew)]

¿Se puede hacer que funcione en las páginas de etiquetas? Encontré el complemento de banners de etiquetas, pero no tiene la capacidad de agregar texto o enlaces a él.