Skip to content

halftrainedharry/SimpleSearch

 
 

Repository files navigation

MODX SimpleSearch

SimpleSearch version MODX Extra by Sterc MODX version requirements

Installation

Simply install it through the top menu Extras > Installer and search for SimpleSearch. Install it from there. After installing it, it is recommended to clear your MODX cache, through the top menu Manage > Clear Cache.

Upgrade risks

First of all: ALWAYS MAKE A BACKUP BEFORE UPDATING!

Upgrading to 2.0.0 from 1.* is highly recommended, but it does introduce some risks.

Important changes from 1.* to 2.0.0:

  • The namespace has been changed from sisea to simplesearch. If you're using custom System Settings, then please migrate them.
  • The placeholder prefix has also been changed from sisea to simplesearch.
  • The ElasticSearch and SOLR drivers have been removed, because they were in need of improvements. Future drivers should be seperate addons. Feel free to ask us for help here.

Autosuggest

A processor has been provided for retrieving a list of search suggestions based on a Template Variable containing a comma delimited list of search terms. You can configure the TV to use by setting simplesearch.autosuggest_tv, which can either be the TV name or id.

You can use the example (requires jQuery) code below for retrieving a list of search suggestions.

$('.simplesearch-search-form input[type="text"]').on('keyup', function () {
    var value = $(this).val();

    $.ajax({
        url         : '/assets/components/simplesearch/connector.php?action=web/autosuggestions&search=' + value,
        dataType    : 'JSON',
        complete    : function (result) {
            console.log(result.results);
        }
    });
});

Bugs and feature requests

We value your feedback, feature requests and bug reports. Please issue them on Github.

Free Extra

This is a free extra and the code is publicly available for you to change. The extra is being actively maintained and you're free to put in pull requests which match our roadmap. Please create an issue if the pull request differs from the roadmap so we can make sure we're on the same page.

Need help? Approach our support desk for paid premium support.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 98.9%
  • Smarty 1.1%