Skip to content

Latest commit

 

History

History
17 lines (14 loc) · 1.55 KB

README.md

File metadata and controls

17 lines (14 loc) · 1.55 KB

discourse-tc-bars 🍻 🍸

A Theme Component that allows you to lay out Components ("widgets1") on top and side bars

  • Specify a set of "widgets" distinctly for Route and Position.
  • Supports setups for each of: discovery2, topic, tag3, category3 OR categories3.
  • "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

Footnotes

  1. Discourse "widgets" have been deprecated, so this TC only supports Components (in any case Glimmer Components are fast and much more pleasant to develop)

  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. 2 3