# Topic List Sidebars

**URL:** <https://meta.discourse.org/t/topic-list-sidebars/107561>\
**Category:** Theme component\
**Tags:** official, topic-list-sidebars\
**Created:** [January 25, 2019, 9:35pm UTC](https://meta.discourse.org/t/topic-list-sidebars/107561 "2019-01-25T21:35:47Z")\
**Posts on this page:** 1\
**Showing post:** 1

<div class="post-metadata">

**Author:** ![Discourse](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/discourse/32/148734_2.png) [@Discourse](https://meta.discourse.org/u/Discourse)\
**Post date:** [January 25, 2019, 9:35pm UTC](https://meta.discourse.org/t/topic-list-sidebars/107561/1 "2019-01-25T21:35:47Z")

</div>

> ℹ 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. |
| 👓 | **Preview** | [Preview on Discourse Theme Creator](https://discourse.theme-creator.io/theme/Discourse/topic-list-sidebars) |
| 🛠 | **Repository Link** | [https://github.com/discourse/discourse-topic-list-sidebars](https://github.com/discourse/discourse-topic-list-sidebars) |
| 📖 | **New to Discourse Themes?** | [Beginner’s guide to using Discourse Themes](https://meta.discourse.org/t/beginners-guide-to-using-discourse-themes/91966) |

Install this theme component

> [@](#):
>
> :discourse2: As this is an #official theme component maintained by the Discourse team, #Support, #Contribute > Bug, #Contribute > UX, and #Contribute > Feature requests can be made in the respective categories here on Meta, and tagged with the appropriate theme component tag. Click on a link below to get one started. 👍
> 
> [❓&nbsp; **Support**](https://meta.discourse.org/new-topic?category_id=6&tags=topic-list-sidebars "Ask for support on configuring and using Topic List Sidebars") [🐛&nbsp; **Bug**](https://meta.discourse.org/new-topic?category_id=1&tags=topic-list-sidebars "A bug report means something is broken, preventing normal/typical use of the theme component") [👀&nbsp; **UX**](https://meta.discourse.org/new-topic?category_id=9&tags=topic-list-sidebars "Discussion about the user interface of Topic List Sidebars, and how features are presented (including language and UI elements)") [💡&nbsp; **Feature**](https://meta.discourse.org/new-topic?category_id=2&tags=topic-list-sidebars "Discussion about how existing Topic List Sidebars features can be improved or enhanced, and how proposed new features could work")

### 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).

 ![topic list sidebar example](https://global.discourse-cdn.com/meta/original/3X/0/6/06232990c15daef67651d20fb17e9be04686e5be.png)

### 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

 ![edit sidebar settings](https://global.discourse-cdn.com/meta/original/4X/1/0/6/106db0ef1e23d25ef4d17e5acef8a7e06ffc7ade.png)

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

❤ 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 document**
> >
> > Perform check on document:

---

_[View the full topic](https://meta.discourse.org/t/topic-list-sidebars/107561)._
