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:
- In the Confluence editor, choose
> Other Macros - Find and select the required macro
Speeding up macro entry with autocomplete:
- In the new editor - Type / and the beginning of an element (tool or things in the insert menu) to see a list of suggestions.
- In the legacy editor - Type { and the beginning of the macro name to see a list of suggested macros.
Details are in Keyboard shortcuts, markdown, and 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. 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 | all spaces | Specify a space key to limit the search to the given space. Case-sensitive. Alternatively, use |
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
Wiki markup is useful when you need 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}