This is the documentation for the design, implementation, development and usage of the SimpleSearch WidgetType.
| Note |
|---|
This page's purpose is to define the rough shape and design of a SimpleSearch widget. If you are looking to define a new SimpleSearch widget definition then you should read through this schema to understand the correct shape for that JSON. If you need help translating the schema to a JSON shape then you can read this page as a guide. Please note that we will not be creating a full JSON schema breakdown for every WidgetType that we construct. Instead a combination of pages like this one, the JSON schema itself and the above JSON breakdown, along with any existing WidgetDefinition examples, should be sufficient to translate the schema into a working definition. |
...
The fields to fill out in a WidgetDefinition using SimpleSearch are as follows:
- columns
- filters
- sort
- configurableProperties
columns
This is used to define the options a user will be able to pick from for their table display in the widget.
filters
This is used to define the options a user has to configure their widget search filters.
sort
This is used to define the options a user has to sort the response their filtered search returns.
...
Screenshots
