The Livesearch macro allows you to add a search box to a Confluence page. When users enter a search term into the search box, Confluence will dynamically display matching results as they type.

Using the Livesearch macro

To add the Livesearch macro to a page:

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

Speeding up macro entry with autocomplete:

Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete.

To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.


Parameters

Parameters are options that you can set to control the content or format of the macro output.

Parameter

Default

Description

Restrict to this Space Key

all spaces

Specify a space key to limit the search to the given space. Case-sensitive.

Restrict to label(s) Specify labels to limit the search to content with that label. If unspecified will search all content regardless of label.
SizemediumChoose a medium or large search field size.
Placeholder text Specify the placeholder text to appear in the search field, for example 'Search this space'
TypeallSpecify the content types to be included in the search - choose from pages, blogs, comments, space descriptions, or all content types.
Additional space nameDisplay the space name, a page excerpt or nothing under the search result.

Code examples

See:

Related topics

Searching Confluence
Search Results Macro
Working with Macros

Take me back to the Confluence User's Guide.

  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.