Loading ...

Search Widget | Axero Documentation

Home » axero documentation » Wiki » Documentation » Control Panel » System » Page Builder » Page Builder Widgets » Search Widget
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 12

Search Widget

0 
 /5
0 (0votes)

The Search widget inserts a search bar that users can use to search for content or people. You can set which space to search in.

Properties

Property Description
Title The widget title appears at the top of the widget
Space The space to search in

Templates

Employee Lookup Template 

The Employee Lookup template displays a search bar that searches people.

Search Template 

The Search template displays a search bar that searches your entire intranet or a specific space.

Advanced

Field Description
Icon Select an icon to display with the widget (Requires a template that uses {{IconCSSClass}})
Custom CSS class A CSS class to append to the widget
Show Header Check to show the widget's header, which includes the title
Show Footer Check to show the widget's footer
Hide Container Border Check to hide the widget's border

Roles

Choose the roles that can view this widget.

 

Mobile Search Widget

Search widget in mobile is available.

1. To implement go to Page Builder page that you want to put the widget on, select Mobile Layout, drag Search widget to location you want, then Edit Properties.

2. Select space you want the widget to search. Click Save.

3. Widget is now on Mobile layout.

+ Technical Specifications

To be rendered as a Search Widget in the mobile app the template must have the class axero-search-widget. If it has the class hide, it will be rendered as a toolbar icon instead.

Parameters in div component

data-el-search-button
Selector search button. Required if widget not hidden.
data-el-clear-button
Selector clear button to clear text input. Optional.
data-el-search-results
Selector div element where to show suggestions. Required if widget not hidden.
data-el-spinner
Selector spinner element. Optional.
data-debounce-time
Microseconds to debounce REST API calls. Default 300.
data-results-long-format
If "true" suggestions will have long format with content snippets.

Parameters passed to search REST-API

See possible values in REST API Search

 

data-param-space-id-csv
Comma-separated list of unique IDs of spaces from which the content is to be returned.
data-param-entity-type-csv
Comma-separated list of entity types of the content to be returned.
data-param-user-id-csv
Comma-separated list of unique IDs of the users whose content is to be returned.
data-param-exact-match
If it is set to true, then it will search the exact keyword in the index, otherwise there is no need to set this value.
data-param-tag-id-csv
Comma-separated list of the IDs of tags in a tag group content should be tagged with.
data-param-tag-group-id-csv
Comma-separated list of the IDs of tag group content should be tagged with.
data-param-tags
The keywords content should be tagged with.
data-param-from-date-string
The earliest creation date returned content should have. The date format should be YYYYMMDD.
data-param-to-date-string
The latest creation date returned content should have. The date format should be YYYYMMDD.
data-param-is-featured
Used to get content marked as "featured".
data-param-category-id
Category ID for Articles, Blogs, Videos, CMSPages & Ideas.
data-param-search-only-tags
Specifies whether to search for the keyword in tags only or not. True or false.
data-param-parent-content-id
ID of the parent content from which content is to be returned.
data-param-sort-by
Sort content based on a column.
data-param-sort-order
The order in which content is to be sorted.
data-param-title-length
Number of characters to return for the content title.
data-param-summary-length
Number of characters to return for the content summary.
data-param-is-generic-content-search
To fetch only content.

 

Examples

Basic search widget

<div id="axero-search-widget-{{WidgetID}}" class="axero-widget {{CustomCSSClass}} {{#if HideContainerBorder}}axero-widget-no-border{{/if}} axero-search-widget" 
 data-param-space-id-csv="{{Contents.SpaceID}}"
 data-el-spinner=".axero-search-suggest-loading"
 data-el-input-search=".input-search"
 data-el-search-results=".search-results"
 data-el-search-button=".input-button">
    {{#if ShowWidgetHeader}}
    <div class="axero-widget-header">
        <h3>{{{WidgetTitle}}}</h3>
    </div>
    {{/if}}
    <div class="axero-widget-content">
        <div class="search-container">
            <a href="#" title="{{Resources.GlobalSearchText}}" class="btn input-button"><i class="icon-search"></i></a>
            <div class="search-textbox">
                <div class="axero-search-suggest-loading hide" ><span class="spinner"></span></div>
                <input type="text" placeholder="{{Resources.GlobalSearchText}}" class="input-search" value="{{Contents.SearchTerm}}">
            </div>
        </div>
        <div class="search-results"></div>
    </div>
</div>

 

Search widget to be placed in toolbar

<div id="axero-search-widget-{{WidgetID}}" class="axero-widget {{CustomCSSClass}} {{#if HideContainerBorder}}axero-widget-no-border{{/if}} axero-search-widget hide"
 data-param-space-id-csv="{{Contents.SpaceID}}"
 data-el-spinner=".axero-search-suggest-loading"
 data-el-input-search=".input-search"
 data-el-search-results=".search-results"
 data-el-search-button=".input-button">
</div>

 

Wiki Index

Pages