SearchSuggestionBaseWidget
Namespace
Ceres\Widgets\Header\Search
Extends
Implements
Type | Name | Value | Description |
---|---|---|---|
|
['','bold,italic,underline,strike |
h1,h2,h3 |
|
align |
translation','bold,italic,underline,strike |
headline |
link |
align,ul,ol |
color,background |
translation'] |
Type | Name | Description |
---|---|---|
|
The template to be used for this widget |
|
|
The key of the widget |
|
|
The label of the widget |
|
|
The url of the preview image |
|
|
The position of the widget |
|
|
The type of the suggestion widget |
|
|
The headline of the suggestion widget |
|
|
Indicate if the suggestion widget has the option to show counts behind the suggestions |
|
|
Indicate if the suggestion widget has the option to show images for the suggestions |
|
|
Indicate if the suggestion widget has the option to show additional information for the suggestions |
Methods
public getData():array
Get basic information about the widget. Possible fields are - identifier - label - previewImageURL - type - categories - position
public getSettings():array
Return the structure of the settings for the widget
public getTemplateData($widgetSettings, $isPreview):array
Get additional data to be passed to the template while rendering.
Type |
Name |
Description |
|
The settings provided by the widget. |
|
|
A flag provided to determine if the widget is currently shown in preview. |