https://github.com/merefield/discourse-tc-bars
A Theme Component that allows you to lay out Components ("widgets") on top and side bars
https://github.com/merefield/discourse-tc-bars
Last synced: 5 months ago
JSON representation
A Theme Component that allows you to lay out Components ("widgets") on top and side bars
- Host: GitHub
- URL: https://github.com/merefield/discourse-tc-bars
- Owner: merefield
- License: gpl-2.0
- Created: 2023-12-21T10:38:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-09T07:28:34.000Z (about 1 year ago)
- Last Synced: 2025-06-09T08:29:15.395Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 116 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# discourse-tc-bars :beers: :cocktail:
A Theme Component that allows you to lay out Components[^1] on top and side bars.
* Specify a set of "widgets" distinctly for Route and Position.
* Supports setups for each of: discovery[^2], topic, tag[^3], category[^3], categories[^3] OR tags-intersection[^4]
* "Bars" can be either: top, left, right OR alternative right location.
* Each bar can be collapsed or dismissed (refresh browser to reset dismiss). They can be minimised by default.
* Handles the Official Sidebar, but if you intend you use a Bars Left Sidebar, the Dropdown mode of the official Sidebar is recommended.
* It comes with existing example settings that show some big letters, partly as a demo and partly so you can see example settings. Delete these and replace with your own Component names.
* Ships with one Component: `bars-custom-html` (see pre-filled example settings) - but components from many existing Theme Components & Plugins are compatible.
* Mobile support is not yet implemented.
[Discussion Topic Here](https://meta.discourse.org/t/discourse-bars-a-sidebar-framework/298216)
[^1]: This TC supports Glimmer Components which must be "self-contained" ie fetch their own data (so they remain fully modular and can be used on any route)
[^2]: the term 'discovery' (route) refers to the main Topic List pages (e.g. "Latest", "New") that allow you to browse available Topics before clicking and diving into a specific one.
[^3]: technically also a "discovery" route but we're breaking these out to distinct names so you can treat them differently if you so choose.
[^4]: See the [Tags Intersection Plugin](https://meta.discourse.org/t/tag-intersection-navigator/368815?u=merefield)