主题列表侧边栏

:information_source: Formerly “Discourse Category Sidebars” — the name of this theme component has been updated to Topic List Sidebars now that it supports both categories and tags.

:discourse2: Summary Topic List Sidebars takes a topic and applies it as a sidebar for a category or tag’s topic list.
:eyeglasses: Preview Preview on Discourse Theme Creator
:hammer_and_wrench: Repository Link https://github.com/discourse/discourse-topic-list-sidebars
:open_book: New to Discourse Themes? Beginner’s guide to using Discourse Themes

Install this theme component

Features

This theme component takes a topic and applies it as a sidebar for a category or tag’s topic list. These sidebars are only visible when the browser is 767px or wider (most tablets and monitors).

What can I do with this theme component?

  • Choose a topic and display its content as a sidebar for a category or tag.

  • Set a sidebar to be displayed on the /latest, /new, /unread, and /top pages by using all as the category name in your settings.

  • Choose for the sidebars to appear on the left or the right of the topic list.

  • By default a category’s sidebar will also display for all its subcategories unless a subcategory has its own sidebar defined (you can disable this by unchecking the inherit parent sidebar setting).

How do I configure it?

Choose your categories and tags, and add the id of the topic (e.g. example.com/t/example-topic/57) that you would like to use to populate the sidebar’s content

I recommend creating sidebar topics in their respective categories/tags, closing the topic so there are no replies, and unlisting it (so it doesn’t appear in the topic list).

Note that you cannot use a topic in a private category as a sidebar in a public category (you can technically, but users without access to that private topic will just see a empty sidebar!).

Settings

Name Description
sidebars Add and remove sidebars
sidebar side Choose from Left or Right
inherit parent sidebar If checked subcategories will inherit their parent category’s sidebar (unless the subcategory has its own sidebar assigned).

When unchecked subcategories will only display a sidebar if one is specified.
stick on scroll When checked sidebar has a sticky position on scroll

Developer Notes

Each category sidebar is wrapped with a class that contains the category slug, so for the staff category that would be .category-sidebar-staff. You can use these classes to style the individual sidebars.

The body tag on pages with sidebars also has a class added so you can use body.custom-sidebar to apply styles on all pages that have a sidebar.

Credits

:heart: Special thanks to @xrav3nz for laying the groundwork to make this component possible!


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

Last edited by @JammyDodger 2024-06-18T11:18:45Z

Check documentPerform check on document:
59 个赞

Trying to figure out how to make this work with tags as well. (we use tags heavily rather than having tons of categories.)

It looks like it may be about replacing controller:navigation/category with whatever the equivalent for tags is but not sure.

2 个赞

I just took a quick look and it’s possible to do this for tags…

I’ll probably work on this more tomorrow and spin it off into its own repo.

Yep, that’s the core of it — this seems to work for tags:

const controller = container.lookup("controller:tags-show");
const tag = controller.get("tag");

Update: I’ve got a theme component available, Discourse Tag Sidebars

10 个赞

Since I am using the header submenu plugin, A part of the text is covered by my header bar. It would be great if it was possible to add extra margin/offset or whatever it’s called for the case when additional elements before the header are covering the sidebar’s content.

Also: is there any way to keep the category drop down menu above the sticky sidebar’s content? that would make it easy for users to jump between categories quickly.

altogether I think the category sidebar is a great plugin and has huge potential to add useful information to the forum structure!

Another great plug-in Kris, thanks!

I have a few questions/suggestions that I hope you can help with…

1 - Is it possible to make this so that when a user browses the forum, going from page to page the sidebar always checks for the latest version of the post that it contains? At the moment I think the content of the sidebar only updates on a page refresh? Unfortunately content that rarely changes begins to appear stale to users (particularly active users) and so I’d like to update the topic associated with the sidebar frequently if I can. (Similarly, if the ID of the topic in the options for that page is changed, it would pick it up on the next page-view). I’m quite happy for the additional load per page/view but if you’re worried others may not be perhaps you could add a “cache post contents” option which would make it work like it does now.

2 - Is it possible to associate/pick up content from more than one topic per sidebar please? So for example on the Latests page you might want the content from topics 33,55 (and in that order). This would be great to allow different content per page while also include common info/links that you might want to appear at the bottom of every sidebar.

3 - Is it possible to expand the plugin so it can be used site-wide please? At the moment I think it can only be used on certain pages? Ideally I’d like to use this across the whole forum on all main sections/pages. (Perhaps your tags sidebar plugin could be used in conjunction with this for finer control - eg for individual tags and/or Topics - I think both combined could become a very power sidebar package!!)

4 - Is it possible to add a sidebar width option as well as a configurable cut-off/display-none point please? This isn’t a biggie as it can be done via css changes but think it would be nice to have in the options.

5 - Last but not least… could you get polls to work please? I think allowing users to vote in polls right out of the sidebar would be awesome!!! I find dynamic content like this in sidebars can make them interesting to users, and so less likely that they’ll automatically ignore them.

I think with all the above this plugin would make a very good candidate to be included in core or an official DC plugin - imo it could help people put an individual stamp on their forums and I’m sure people would use them in fun and interesting ways! :smiley:

Hello,

Great component. Is it possible to have such sidebar for each topic under a specific category?

Thanks.

What is the syntax to adress a subcategory? Things I tried so far:

category/subcategory,123
subcategory,123
category-subcategory,123

None of these seem to work. Main categories are displayed, though.

1 个赞

Hm, anyone, please? It shouldn’t be that hard to give an answer…

It looks like there was a regression and subcategories weren’t working in some cases, the syntax should be the same as categories: subcategory, 123

I’ve refactored the theme, so if you update it subcategories should work as expected!

6 个赞

That did the trick: perfect!
Thank you so much, just in time for our grand opening.

1 个赞

很棒的插件!

这个插件是否也支持群组?为群组设置侧边栏将非常有助于提供群组信息。

有人能指引我如何获取群组参数(让组件知道你正处于某个群组中),以便我尝试自己创建一个 PR 吗?

@hyphalos 我创建了一个群组小部件,可以添加到布局插件的侧边栏中。

也许我为它编写的代码可以帮助您编写您的 PR:

或者,您也可以使用布局插件和小部件本身。

2 个赞

虽然要求有点大胆,因为它被称为“侧边栏”,但还是想问一下:是否有可能添加一个选项,将内容始终放在主题列表的“上方”,而不是旁边?

我们使用 Discourse 作为社交内联网,对于某些类别,我们需要一个易于维护的区域来放置链接、人员列表等。——这种机制对此会很棒,但侧边栏的空间太小了。
CSS 技巧也欢迎。

我已经尝试过分类横幅,但它们仅限于第一段,所以这不是一个选项。

此致,
Ralf
(柏林州立图书馆)

关于这个TC呢?

我认为你仍然会被第一个段落困住。但这可能会被改变。

嗨 Kris,这相当不错。

我想知道这是否可以修改,或者是否有一个选项可以将其从侧边栏移到网站标题下方的顶部栏,或者只是移到类别徽标下方?

或者,如果我可以获得有关添加自定义 CSS 来移动它的指导,并且让它在移动设备上显示为顶部,它是否是一个固定的栏? 锚定在主网站栏正下方?

我可能误解了这个主题组件的工作方式,但它是否可以用来将主题列表显示在左侧,点击列表中的某个主题,然后在右侧显示帖子(并保持主题列表固定在左侧)?我不需要看到分类。它看起来会像 Flarum。

1 个赞

不,此组件的作用是获取主题的内容,并使用它来填充特定类别的列表的主题边栏。导航到主题时,它不可见。

好的,谢谢!

大家好!我刚刚对这个组件进行了一次重大更新,它做了几件事:FEATURE: include tag sidebars, migrate to objects setting by awesomerobot · Pull Request #22 · discourse/discourse-topic-list-sidebars · GitHub

  • 将列表样式设置迁移到对象设置。这意味着:

现有设置在更新时应自动迁移……除非您的 slug 与类别名称不同,那么您需要手动更新设置。

例如,site-feedback 将正确迁移到 Site Feedback,但没有方法可以迁移与名称不匹配的 slug(例如,Site Feedback 的 slug 是 hamburgers 而不是 site-feedback)。

我可能会更改此主题组件的名称,并弃用标签侧边栏以反映新情况。

5 个赞

这会自动迁移标签设置吗?

有了新的设置,同一个标签在不同的分类中可以有不同的侧边栏吗?冲突如何解决?

2 个赞