Livesearch Macro

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. From the editor toolbar, choose Insert > Other Macros
  2. Find and select the required macro

Speed it up with autocomplete: Type and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro.

To edit an existing macro: Click the macro placeholder and choose Edit. This will open the macro details, so you can edit the macro parameters.


Parameters

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter

Default

Description

Restrict to this Space Key
(spaceKey

all spaces

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

Alternatively, use @self to restrict the search to the current space.

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

Wiki markup example

This example is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: livesearch

Macro body: None.

{livesearch:spaceKey=DOC|size=large|placeholder=Search this space}
Last modified on Mar 20, 2018

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.