Directory Search Form API
The Directory Search Form API enables you to easily embed the search form for the app on any other page.
Minimum Tag
{{ _api.directory.searchForm.template('template-key') }}
Example Tags
Get the search form for a specific Directory app instance.
This is only necessary if there are multiple app instances.
{{ _api.directory.searchForm.template('template-key').instanceKey('app-instance-key') }}
Tag Parameters
| Parameter | Description |
|---|---|
| instanceKey
i |
The key for the instance to get results in. If nothing is passed then the current instance will be used if this is called within the same app. You can alternately use the short form "i" (lowercase I) instead of "instanceKey" Type: String Examples: instanceKey('app-instance-key') i('app-instance-key') |
| template
t |
Required if responseFormat is not 'data'. The template key of the template to use. If this is not passed when it's required then nothing will be returned. In some cases, by not passing this parameter you will get just the raw data back. You an alternately use the short form "t" instead of "template" Type: String Examples: template('template-key') t('template-key') |