Go to file
Penar Musaraj 7dd9002c9f
DEV: Override `clickOutside` following core change (#28)
See discourse/discourse#20950
2023-04-04 10:00:30 -04:00
.github/workflows DEV: Update CI workflows (#23) 2023-01-10 19:31:09 +00:00
common Minor prettier fix (#27) 2023-03-31 11:57:08 -04:00
javascripts DEV: Override `clickOutside` following core change (#28) 2023-04-04 10:00:30 -04:00
locales initial commit 2019-07-14 23:31:20 -04:00
mobile FIX: add clearContext, general cleanup (#25) 2023-03-08 09:29:00 -05:00
stylesheets Add dark theme background image (#26) 2023-03-31 11:30:34 -04:00
.discourse-compatibility DEV: Override `clickOutside` following core change (#28) 2023-04-04 10:00:30 -04:00
.eslintrc DEV: Add CI setup and fix linting issues (#11) 2022-05-13 13:55:40 +02:00
.gitignore DEV: Add CI setup and fix linting issues (#11) 2022-05-13 13:55:40 +02:00
.prettierrc DEV: Add CI setup and fix linting issues (#11) 2022-05-13 13:55:40 +02:00
.template-lintrc.js DEV: Add CI setup and fix linting issues (#11) 2022-05-13 13:55:40 +02:00
LICENSE Create LICENSE 2019-07-14 23:57:08 -04:00
README.md Ensure README images are pointing to discourse/gh-owned repositories (#24) 2023-01-25 17:34:33 +05:30
about.json DEV: Add CI setup and fix linting issues (#11) 2022-05-13 13:55:40 +02:00
package.json DEV: Add CI setup and fix linting issues (#11) 2022-05-13 13:55:40 +02:00
settings.yml Add dark theme background image (#26) 2023-03-31 11:30:34 -04:00
yarn.lock DEV: Update eslint-config-discourse, use prettier for hbs (#22) 2023-01-04 13:46:49 +01: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.

screenshot

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

🔭 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