# Right Sidebar Blocks

**URL:** https://meta.discourse.org/t/right-sidebar-blocks/231067
**Category:** Theme component
**Tags:** official, desktop, right-sidebar-blocks
**Created:** [June 25, 2022, 2:55am UTC](https://meta.discourse.org/t/right-sidebar-blocks/231067 "2022-06-25T02:55:24Z")
**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: [June 25, 2022, 2:55am UTC](https://meta.discourse.org/t/right-sidebar-blocks/231067/1 "2022-06-25T02:55:24Z")

</div>

| | | |
| --- | --- | --- |
| :discourse2: | **Summary** | **Right Sidebar Blocks** shows a sidebar to the right of topic lists with a configurable list of blocks. |
| 👓 | **Preview** | [Preview on Discourse Theme Creator](https://discourse.theme-creator.io/theme/Discourse/right-sidebar-blocks) |
| 🛠 | **Repository Link** | [https://github.com/discourse/discourse-right-sidebar-blocks](https://github.com/discourse/discourse-right-sidebar-blocks) |
| 📖 | **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=right-sidebar-blocks "Ask for support on configuring and using Right Sidebar Blocks") [🐛&nbsp; **Bug**](https://meta.discourse.org/new-topic?category_id=1&tags=right-sidebar-blocks "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=right-sidebar-blocks "Discussion about the user interface of Right Sidebar Blocks, and how features are presented (including language and UI elements)") [💡&nbsp; **Feature**](https://meta.discourse.org/new-topic?category_id=2&tags=right-sidebar-blocks "Discussion about how existing Right Sidebar Blocks features can be improved or enhanced, and how proposed new features could work")

### Features

The component includes a few blocks you can display in the sidebar:

- popular-tags
- top-contributors
- recent-replies
- category-topics
- custom-html
- category-list
- subcategory-list
- upcoming-events-list\*
- minimal-gamification-leaderboard\*\*

> ℹ The user directory must be enabled for the Top Contributors list to be populated. If your list is blank, search `enable user directory` in your admin settings to make sure it’s enabled.

\* Only available when used with the [Calendar](https://meta.discourse.org/t/discourse-calendar-and-event/97376) plugin.  
\*\* Only available when used with the [Gamification](https://meta.discourse.org/t/discourse-gamification/225916) plugin.

You can also use other Ember components as blocks, you just need to use the correct name. For example, core includes a `signup-cta` Ember component, and you can use it in the sidebar as is. Note that you can’t use components that expect a set of parameters, but you _can_ build your own Ember component in a separate theme and reference it just by its name in the sidebar’s `blocks` setting.

You can control some features for the provided blocks via parameters.

| name | description | default | value | available for |
| --- | --- | --- | --- | --- |
| `count` | limits number of results | varies | number | all except custom-html |
| `excerptLimit` | limits length of each reply excerpt | 150 | number | recent-replies |
| `id` | category id | | category id (category-list uses comma-separated) | category-topics, category-list |
| `content` | contents to display | | html | custom-html |
| `scopeToCategory` | only shows in category or subcategory X | | category id | popular-tags |
| `excludedTags` | list of excluded tags | | tagnames | popular-tags |
| `displayInSpecificCategories` | list of categories to show the widget | all | comma-separated numbers | popular-tags |
| `id` | leaderboard id | | number | minimal-gamification-leaderboard |
| `tag` | which tag to display | | tag name | tag-topics |
| `period` | time period of top topics | weekly | all, yearly, quarterly, monthly, weekly, daily | top-topics |
| `title` | title of the block | varies | string | tag-topics, category-list, top-contributors |
| `excludedGroupNames` | excludes specified groups | | Group names | top-contributors |
| `order` | orders the contributors | | String (likes\_received or likes\_given) | top-contributors |
| `period` | time period for top contributors | yearly | all, yearly, quarterly, monthly, weekly, daily | top-contributors |
| `includeSubcategories` | includes subcategory events | false | false, true | upcoming-events-list |
| `upcomingDays` | events started before the provided value | 180 | number | upcoming-events-list |
| `timeFormat` | format of event date / time | LT | [momentjs format](https://momentjs.com/docs/#/displaying/format/) | upcoming-events-list |

### Settings

| Name | Description |
| --- | --- |
| blocks | |
| show in routes | Advanced users only: limit sidebar to the selected routes.  
Examples: discovery.latest, discovery.unread, discovery.new, discovery.top, tag.show, “c/category-slug” (for categories), “tag/sample-tag” (for tags).  
When empty, the sidebar is shown on all list routes. |

`blocks`: choose the blocks to display and adjust their ordering

`show_in_routes`: decide on which topic list routes to display the sidebar. By default, it will show it on all discovery routes except for `/categories`.

| Translation | Default |
| --- | --- |
| top\_contributors.heading | Top contributors |
| top\_contributors.view\_all | View all |
| popular\_tags.heading | Popular tags |
| popular\_tags.view\_all | View all |
| recent\_replies.heading | Recent replies |
| subcategory\_list.heading | Subcategories |
| top\_topics.heading | Top topics |
| category\_list.heading | Categories |

### Screenshots

 ![image](https://global.discourse-cdn.com/meta/original/4X/a/8/e/a8e631513d11d9831b1e45b0fe84e5d7932376b5.jpeg)

 ![The image is a screenshot of software settings with a focus on theming and the option to add items to the discovery categories. (Captioned by AI)](https://global.discourse-cdn.com/meta/original/4X/3/0/4/304302ace22a41ecef78a50f4fcb09d5ab0b2b8c.png)

 ![image](https://global.discourse-cdn.com/meta/original/4X/9/8/3/9832fc94e441e48c770aedd1054b5f3d637ba3fe.png)

Note that the component comes with only very basic styling, the assumption is that admins using the component will add their own styling in their own theme.

### Interactions

When used in conjunction with the [Discourse Calendar](https://meta.discourse.org/t/discourse-calendar-and-event/97376) plugin, you can add a sidebar block for your upcoming events. The block name is `upcoming-events-list`, and the date format can be customized following [this syntax](https://momentjs.com/docs/#/displaying/format/) (for example, `MMMM D, YYYY` ). You can also configure how far in the future to look, and if subcategory events are included (see the table above)

 ![Screenshot 2025-05-14 at 2.37.52 AM](https://global.discourse-cdn.com/meta/original/4X/c/d/6/cd686b06c7e7f47f3f619b08240a38453b7d00b3.png)

 ![Screenshot 2025-05-14 at 2.52.11 AM](https://global.discourse-cdn.com/meta/original/4X/3/3/8/338621e8326f692045cae203dfa81bd03040f69f.png)

  

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

> Last edited by @nathank 2026-07-14T22:53:56Z
> 
> > **Check document**
> >
> > Perform check on document:

---

_[View the full topic](https://meta.discourse.org/t/right-sidebar-blocks/231067)._
