Search Highlight module

Search highlight module

Use the Search Highlight module to add a search bar to a page. The search results vary depending on the page the module is placed on:

Search highlight module placed on

Gives search results from

Search highlight module placed on

Gives search results from

The site’s home page.

or

A Refined Page that doesn’t have spaces or projects grouped under it in the site structure.

  • Pages and blog posts from all Confluence spaces on the site.

  • Issues from all Jira projects on the site.

  • Request types from all JSM projects on the site.

  • Links.

  • Landing pages: the site’s home page, Refined pages, and customizable pages that feature a space or project.

  • Articles from knowledge bases added to JSM projects.

  • Promoted search results, no matter which location they’re set to.

The landing page of a space or project.

or

A Refined Page that has spaces or projects grouped under it in the site structure.

  • The pages and blog posts of the space, and of spaces grouped underneath it in the site structure.

  • Jira issues of the project, and of projects grouped underneath it in the site structure.

  • JSM request types of the project, and of projects grouped underneath it in the site structure.

  • Articles from knowledge bases added to the JSM project, and of JSM projects grouped underneath it in the site structure.

  • Promoted Search Results with the relevant location set.

Add this module to a page

  1. Go to a landing page on your site.

  2. Click the Edit page button.

  3. Hover your mouse over the desired location on the page and click the + Add module button that appears.

  4. Click Search in the left-hand menu.

  5. Select the Search Highlight module.

Edit the title

Simply click the module’s title to start writing and formatting. You can use text variables to make the text dynamic, for example to display the user’s first name.

Edit settings

  1. Click the module to open its settings menu, which appears on its right-hand side.

  2. Edit the settings, which are divided over multiple tabs:

Module tab

Setting

Description

Setting

Description

Background

Add an Image, Color, or Gradient as background – or turn off the background by selecting None.

There are multiple ways to pick a color:

  • Select the shade and hue at the top of the popup.

  • Enter an RGB, RGBA, or hex code.

  • Click the eyedropper icon to select a color from anywhere on the page (available in the browsers Firefox and Edge).

  • Click one of the recently used colors.

Use the vertical slider in the middle of the popup to control the color’s opacity.

Fixed height

By default, all modules adjust their size to their content. To set a fixed height instead, fill in the desired height in pixels.

Search Highlight tab

Setting

Description

Setting

Description

Placeholder text

Add default text that shows in the search bar until users start typing, for example to suggest a specific query.

Search bar style

Light, Dark, or Gray.