Considering Confluence Cloud?
Get the high-level details of Confluence Cloud and available features by plan.
Insert the Live search macro
The Live search 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 Live search macro
To add the Live search macro:
When editing, select from the toolbar
Find the macro by name and select it
Configure it as needed
You can also type / on the page to bring up the same list you'd see by selecting from the toolbar. Continue typing the name of the macro to filter the list.
To edit the Live search macro:
Select the macro placeholder.
Select the Edit icon to open the configuration panel.
Configure the parameters. Your changes are saved as you go.
Resume editing the page, and the panel closes.
You can also select the centered , medium-width , and full-width icons to adjust the width of some macros. Select the trashcan iconto remove the macro.
Parameters
Parameters are options that you can set to control what and how content from the macro appears on the page.
If the parameter name used in Confluence Cloud storage format is different than the label used when inserting macros using the browser or the slash command, 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 @self to restrict the search to the current space. |
Restrict to label(s) |
| Specify labels to limit the search to content with that label. If unspecified will search all content regardless of label. |
Size | medium | Choose a medium or large search field size. |
Placeholder text |
| Specify the placeholder text to appear in the search field, for example 'Search this space' |
Type | all | Specify the content types to be included in the search - choose from pages, blogs, comments, space descriptions, or all content types. |
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.
1
2
3
4
{livesearch:spaceKey=DOC|size=large|placeholder=Search this space}
Was this helpful?
Still need help?
The Atlassian Community is here for you.