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.
Use the Livesearch macro
To add the Livesearch macro:
- In the Confluence editor, select
> View more - Find the item to be inserted and select it
- Select Insert
You can also type / onto the page to bring up the same list you'd see by selecting from the toolbar.
To edit the Livesearch macro:
- Select the macro placeholder. The floating toolbar appears.
- Select Edit. The right panel opens.
- Modify the parameters. Your changes are saved as you go.
- Resume editing the page, and the panel closes.
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 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 only supported in the legacy editor.
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}