Go to file
Kelv 1e550163e6
DEV: Update linting setup (#69)
2024-10-17 11:29:35 +02:00
.github/workflows DEV: Update CI workflows (#23) 2023-01-10 19:31:09 +00:00
common UX: fix alignment for RTL languages (#67) 2024-09-06 17:37:07 -04:00
javascripts/discourse FIX: don't use fallback key as button text (#55) 2024-05-06 13:37:34 -04:00
locales Update translations (#65) 2024-08-20 17:55:00 +02:00
mobile UX: fix button alignment, remove dead CSS (#56) 2024-05-13 13:18:18 -04:00
spec/system DEV: Update linting setup (#69) 2024-10-17 11:29:35 +02:00
stylesheets Add dark theme background image (#26) 2023-03-31 11:30:34 -04:00
test/acceptance DEV: Update linting (#53) 2024-03-27 22:55:23 +01:00
.discourse-compatibility DEV: Pin theme for Discourse < 3.4.0.beta1-dev (#63) 2024-08-02 17:41:35 +08:00
.eslintrc.cjs DEV: Update linting (#47) 2023-11-29 23:06:37 +01:00
.gitignore DEV: Add CI setup and fix linting issues (#11) 2022-05-13 13:55:40 +02:00
.npmrc DEV: Switch to use pnpm (#68) 2024-10-14 11:28:22 +02:00
.prettierrc.cjs DEV: Update linting (#47) 2023-11-29 23:06:37 +01:00
.rubocop.yml DEV: Update linting setup (#69) 2024-10-17 11:29:35 +02:00
.streerc DEV: Update linting setup (#69) 2024-10-17 11:29:35 +02:00
.template-lintrc.cjs DEV: Update linting (#47) 2023-11-29 23:06:37 +01:00
Gemfile DEV: Update linting setup (#69) 2024-10-17 11:29:35 +02:00
Gemfile.lock DEV: Update linting setup (#69) 2024-10-17 11:29:35 +02:00
LICENSE DEV: Change license to MIT (#60) 2024-06-19 12:44:28 +10:00
README.md Ensure README images are pointing to discourse/gh-owned repositories (#24) 2023-01-25 17:34:33 +05:30
about.json Update about.json (#57) 2024-06-05 09:48:55 -04:00
package.json DEV: Update linting setup (#69) 2024-10-17 11:29:35 +02:00
pnpm-lock.yaml DEV: Update linting setup (#69) 2024-10-17 11:29:35 +02:00
settings.yml UX: add "discovery" option, plugin outlet (#30) 2023-04-18 15:20:25 -04:00
translator.yml DEV: Add Crowdin support (#58) 2024-06-11 13:37:48 +02: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