Go to file
discoursebot 24b424b9c0
DEV: Update CI workflows (#23)
Co-authored-by: discoursebuild <build@discourse.org>
2023-01-10 19:31:09 +00:00
.github/workflows DEV: Update CI workflows (#23) 2023-01-10 19:31:09 +00:00
common FEATURE: optional setting for special style (#18) 2022-10-18 13:02:20 -04:00
javascripts DEV: Update eslint-config-discourse, use prettier for hbs (#22) 2023-01-04 13:46:49 +01:00
locales initial commit 2019-07-14 23:31:20 -04:00
mobile initial commit 2019-07-14 23:31:20 -04:00
stylesheets FEATURE: optional setting for special style (#18) 2022-10-18 13:02:20 -04:00
.discourse-compatibility REFACTOR: Use `logSearchLinkClick` core helper (#10) 2022-04-01 10:35:38 -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 DEV: Update repo URL in README (#12) 2022-05-16 13:55:40 -04:00
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 FEATURE: optional setting for special style (#18) 2022-10-18 13:02:20 -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.

17%20PM|690x326

🏗️ 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