Documentation

Powered by Minitek FAQ Book

Search forms

A search is performed via a search form. You must create at least one search form and attach it to a menu item or a module. Search form parameters override the global configuration parameters.


  Info

For each search form parameter, the option Use Global inherits the value from the component global configuration.


Form


Form class
An optional class to be applied to the form container.
Alternative Layout
Allows for using a different layout from a template override.
Active search term
The form will be initially loaded with this search term.
Layout
Sets the layout for the search form. The Dropdown layout is ideal when using the Minitek Live Search module, as the filters and results display in dropdown containers. The Modal layout requires Bootstrap 5.
Modal window title
The title for the modal window. Leave empty to disable the title.
Modal button text
The text for the modal button. Leave empty to show only the search icon.
Log search terms
Logs the search terms submitted by users.
Append to URL
Appends search parameters to URL and adds an entry to the browser's session history stack.
Word match
Sets how search terms are matched in the index. By default a word is matched exactly, but when a language supports compound words, this allows to match the search term to the beginning or to any position inside of words.
Search in titles only
Enables searching only in items titles.
Search placeholder
The placeholder text for the search input field.
Search suggestions
Displays search suggestions while the user is typing.
Popular searches
Displays the 10 most popular searches when the search input is focused.
Search query link
Redirects to the menu item selected in the field 'Search query menu item' while maintaining all current search parameters. Applies only when using the Minitek Live Search Module.
Search menu item
The Search query link and the saved searches will redirect to this menu item (must be a Minitek Live Search > Search menu item).
Search tips icon
Displays an icon that toggles the search tips content.
Search tips content
Custom content for search tips.
Empty search content
Custom content for an empty search.

Filters


Filters group
Select the filters group that will be used for this search form.
Content types
The search will be limited to these content types if no filters group has been selected.
Position
  • Top: Displays the filters at the top, above the search results.
  • Sidebar: Filters are arranged vertically in a sidebar. Requires Bootstrap 5 and will work only when the form layout has been set to Default.
Filters
Displays the filters (content maps).
Open filters container
Opens the filters container on page load.
Keep filters open
Groups of children nodes will be visible at all times.
Visible children nodes
Number of visible children nodes for each filter.
Filters max-height
Limits the filters container to this height (in pixels). Enter 0 for unlimited height. Only applies for Dropdown layout.
Active filters
Displays the active filters.
Date filters
Displays the start and end date filters.
Open date filters container
Opens the date filters container on page load.
Active date filters
Displays the active date filters.

Results


Save searches
Allows users to save their searches.
Display messages
Select the type of messages when saving a search.
Alternative search terms
Suggests alternative search terms when a search does not produce any results (eg. 'Did you mean...').
Search terms
Displays the active search terms.
Pagination info
Displays the pagination info (eg. Page 1 of 4).
Scroll to top
Scrolls to the top of the form after clicking on a pagination link.
Results per page
Sets the default number of search results per page.
Select results per page
Allows users to select number of search results per page.
Ordering
The field on which to sort the search results.
Ordering direction
The direction in which to sort the search results.
Select ordering
Allows users to select the ordering of search results.
Highlight search terms
Highlights search terms in search results.
Result image
Displays the result image only for smart search plugins that support items images.
Crop images
If enabled, the images will be cropped to the defined aspect ratio. The images will be cropped starting from the center of the image.

  Info

Cropped images are stored in PATH_TO_JOOMLA/images/mls/. If you change the images in some of the items displayed in the widget, you must click on Delete cropped images in the extension dashboard so that the images are refreshed.

Image max width
Maximum width in pixels for the result image.
Aspect ratio
The aspect ratio of the cropped images.
Result taxonomy
Displays the result taxonomy.
Result description
Displays the result description.
Description length
Description text for search results will be truncated to this character length.
Result date
Displays the result date.
Result URL
Displays the result URL.
Open in new tab
Designates whether the result will open in a new tab.
Was this helpful?
Loading...
1