---json
{
    "canonical": ":searchbox",
    "h1": "ComboStrap UI - Search",
    "name": "Search Box",
    "page_id": "mqzdbften68kg0axgz4oe"
}
---

====== ComboStrap UI - Search Box ======


===== About =====
''search'' is a markup component that will output the search box of the [[docs:app:search|internal search engine]] 

It can be placed in a [[docs:menubar:menubar|menubar component]].


===== Feature =====

==== Quick Access ====

The search component has:
  * the ''f'' accesskey. In chrome, ''Alt+shift+f'' will bring you in the search box.
  * a tabindex of 1. Which means, if you do on Windows ''Alt+D'' + ''Tab'', you comes directly in the search bar.

==== Page List Suggestion ====

When typing in the box, an auto-completion feature will show a list of pages that match the search term against the following metadata:
  * the [[:docs:page:system:path|path]]
  * the [[docs:page:name|name]]
  * the [[docs:page:title|title]]
  * the [[docs:page:h1|heading 1]]


Example when you type the search term ''Search'' on this website:

{{:docs:menubar:pagelist-search-box-combostrap.png|}}

==== Search expression ====

You can enter the following expressions in the search box to refine your search for a term (known below as the search term):

  * ''starts with''
<code>
*searchterm
</code>
  * ''ends with''
<code>
searchterm*
</code>
  * ''contains''
<code>
*searchterm*
</code>
  * Search only in specific [[:docs:page:system:namespace|namespace]]
<code>
*searchterm* @mynamespace
</code>

===== Syntax =====

<code dw>
<search>
</code>

===== Example =====
<webcode name="Default">
<code dw>
<menubar>
<search/>
</menubar>
</code>

</webcode>