admin_search — module reference
Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.
| |
|---|
| Module id | admin_search |
| Name | Global search |
| Version | 1.0.0 |
| Ships from | @endora-commerce/mod-admin-search |
| Licence | MIT |
Activation
An operator switches this module on and off on /platform/modules. The choice is the setting admin_search.enabled, and it defaults to on.
Dependencies
| Module | Binding | What it means |
|---|
_i18n | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
admin_roles | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
auth | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
settings | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
Permissions
| Code | Label | Also needs |
|---|
admin_search:configure | Configure global search | — |
Command palette
| Action | Opens | Permission |
|---|
open-global-search | /global-search | — |
open-global-search-configuration | /global-search/configuration | admin_search:configure |
Settings
| Code | Name | Type |
|---|
admin_search.enabled | Global search enabled | boolean |
admin_search.entity_fields | Searchable fields | json |
admin_search.minimum_query_length | Minimum search length | number |
admin_search.results_per_entity | Results per record type | number |
Translations
Bundles at i18n inside the module, one file per shipped language.
Operator commands
None.