agorum.composite.search.bar

Mit dieser aguila-Komponente können Sie Suchleisten mit Sucheinstellungen in eigene Oberflächen einbauen.

Verwendung

---

let aguila = require('common/aguila');

let barWidget = aguila.create({
  type: 'agorum.composite.search.bar',
  searchWidget: 'agorum.composite.acic',
  settings: require('/agorum/roi/customers/agorum.composite/js/aguila/acic/acic-settings').settings()
});

barWidget;

Parameter

---

settings

Enthält Sucheinstellungen, die links im Auswahlmenü erscheinen (siehe agorum.composite.search.filterResultDetails).

query

(optional) Enthält einen vorausgefüllten Wert für die Eingabe des Suchbegriffs.

Sie können diesen Parameter nachträglich ändern.

Beispiel

barWidget.query = 'test';

settingName

(optional) Definiert einen Namen für die vorgewählte Sucheinstellung.

Sie können diesen Parameter nachträglich ändern.

Beispiel

barWidget.settingName = 'config1';

Events (on)

---

Events, die das Widget sendet, und auf die Sie reagieren können.

settingChanged

Löst aus, sobald Sie eine Einstellung aus dem Auswahlmenü wählen.

Über den Parameter setting lesen Sie die aktuellen Sucheinstellungen aus.

Beispiel

barWidget.on('settingChanged', () => {
  let setting = barWidget.setting;
  let configuration = setting;
  if (setting.type === 'search') {
    // wenn type = search, dann handelt es sich um eine gespeicherte Suche. Die Einstellungen befinden sich in configuration
    configuration = setting.configuration; // Konfiguration, die hinter der gespeicherten Suche hinterlegt ist
    let query = setting.query; // query der gespeicherten Suche
    let filterSelection = setting.filterSelection; // Filterauswahl der gespeicherten Suche
  }
  let baseQuery = configuration .baseQuery;
  let listConfig = configuration .listConfig;
  let listType = configuration .listType;
  let filter = configuration .filter;
  let listConfig = configuration .listConfig;
});

queryChanged

Löst aus, wenn Sie etwas in die Suchleiste eintragen.

Beispiel

barWidget.on('queryChanged', q => {
  let query = q;
});

refresh

Löst aus, wenn Sie die Schaltfläche Aktualisieren anklicken.

Beispiel

barWidget.on('refresh', () => {
  // do something
});

reset

Löst aus, wenn Sie die Schaltfläche Zurücksetzen anklicken.

Beispiel

barWidget.on('reset', () => {
  // do something
});

searchWidget

Definiert optional den Namen des Widgets, das das System aufruft, wenn Sie in der Suchleiste Enter drücken.

Dieses Widget ist für den Standalone-Modus der Suchleiste gedacht.