discourse
/
discourse-search-banner
mirror of https://github.com/discourse/discourse-search-banner.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
10 Commits 6 Branches 0 Tags 653 KiB
SCSS 49.6%
JavaScript 31.4%
Ruby 19%
Go to file
David Taylor 1e6ade528d DEV: Refactor into component with computed properties 
This commit also
  - Removes use of api.onPageChange in favor of the router service
  - Removes JQuery use
  - Uses currentRouteName instead of currentURL so that the bar is hidden for loading substates
 		2020-12-18 11:52:17 +00:00
common DEV: Move JS/HBS into dedicated files 2020-12-18 11:52:17 +00:00
javascripts DEV: Refactor into component with computed properties 2020-12-18 11:52:17 +00:00
locales initial commit 2019-07-14 23:31:20 -04:00
mobile initial commit 2019-07-14 23:31:20 -04:00
.discourse-compatibility Update padding for sticky header, pin old version 2020-10-19 17:58:12 -04:00
.gitignore initial commit 2019-07-14 23:31:20 -04:00
LICENSE Create LICENSE 2019-07-14 23:57:08 -04:00
README.md Create README.md 2019-07-14 23:56:46 -04:00
about.json add license and about links 2019-07-14 23:58:27 -04:00
settings.yml Add ability for user to choose outlet (#2) 2020-12-07 14:23:42 -06:00

README.md

This is a component that puts a search bar along with optional headline and subhead text in a banner above the main topic list navigation of a Discourse community.

By default this banner appears on all top-level topic pages (latest/new/unread/top/categories... anything in the top menu site setting) but it can also be set to only display on a community's homepage.

17%20PM|690x326

🏗️ Github repo: https://github.com/awesomerobot/discourse-search-banner.git

🔭 Preview it on theme creator

❓ How do I install a theme component?

💖 This very heavily borrows from angus' header search component: https://meta.discourse.org/t/header-search-theme/67959

Available settings

  • Set the headline and subhead text
  • Show the banner on all top-level topic pages (default), or just the homepage
  • Set a background image

Custom styling

The HTML element gets a class named .display-search-banner wherever this banner appears, and the banner itself is wrapped with the .custom-search-banner class, so with some CSS you should be able to customize the appearance of this banner however you see fit.

Future enhancements

  • Add an option to enable the banner in specific categories