Annual Documentation Survey

Do you have 4 minutes to help us improve our documentation? Please take our annual survey!

Skip to end of metadata
Go to start of metadata

ThemeBuilder Macro - Panel Search (Quick Search)

Displays the confluence quick-search

Categories: navigation

Usage

Storage Format

<ac:macro ac:name="panel-search">
   <ac:parameter ac:name="parameter">value</ac:parameter>
</ac:macro> 

Wiki Markup

{panel-search:parameter=value}

Parameter

Name

Description

Type

Default

Required

showSpaces

Show Spaces

Display a dropdown of spaces to search within

boolean

false

(error)

filter

Filter

Filter the list of spaces to include only global spaces, personal spaces or both

enum

 

(error)

spaces

Spaces

Only display the following spaces in the dropdown

spacekey

 

(error)

flag

Flag

A list of flags, one of which must be defined for the content to be displayed

string

 

(error)

notflag

Not Flag

A list of flags which must not be defined for the content to be displayed

string

 

(error)

Example

Display the Confluence Search box.

<ac:macro ac:name="panel-search" />
{panel-search}

Result

Used in the ThemeBuilder skin editor header panel the macro will display a Confluence search box, with dropdown for matching content.

Confluence 5 Search Box

The Confluence 5 search box has changed since this macro was created, and the new version can be reproduced using the 'panel-menu' macro.

<ac:macro ac:name="panel-menu">
  <ac:parameter ac:name="menutype">aui-quicksearch</ac:parameter>
</ac:macro>