Search Kit

Introduction

The Search Kit Extension is a graphical search query composer and display editor.

The architecture uses APIv4 to run the queries, and AngularJS for the UI.

Data Model

The main entity in Search Kit is the SavedSearch, which contains the APIv4 parameters needed for running the query.

Each SavedSearch can have zero or more Displays, which are stored in the DB as the SearchDisplay entity, and rendered on the page as AngularJS components.

Integrations

To add a SearchDisplay on a CiviCRM page or form, it can be embedded in an Angular content block such as an Afform.