Skip to content

Commit 8c2151a

Browse files
feat(search): add doc for search extension result
SEARCH-511
1 parent 3196365 commit 8c2151a

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed

docs/javascript/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ And `configuration` is an object that allows these properties:
8686
| `targets.SEARCH` | Target id for the search page. | [Documentation](./capabilities#search) |
8787
| `targets.SEARCH_BOX` | Target id for the search box. | [Documentation](./capabilities#search-box) |
8888
| `targets.SEARCH_CUSTOM_METADATA` | Target id for search custom metadata. | [Documentation](./capabilities#search-custom-metadata) |
89+
| `targets.SEARCH_EXTENSION_RESULT` | Target id for result coming from search extensions. For further information, please refer to the [search SDK documentation](https://docs.lumapps.com/docs/ls/content/7922416882680847/docs/devportal-devportal-landing/devportal-l7646654821110653/devportal-l18963592772091442/devportal-l2842548453481841/devportal-l5187611046361645). | [Documentation](./capabilities#search-extension-result) |
8990
| `targets.SEARCH_RESULT_ICON` | Target id for icons of the search result page and quick search. | [Documentation](./capabilities#search-result-icon) |
9091
| `targets.SEARCH_TAB` | Target id for search tab. | [Documentation](./capabilities#search-tab) |
9192
| `targets.SETTINGS` | Target id for the settings menu. | [Documentation](./capabilities#settings) |
Loading

docs/javascript/capabilities.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,25 @@ Target that allows customizing icons of the search results of both the search pa
592592
This allows specific customization depending on result type / data etc...
593593
In addition, a `SearchThumbnail` component is available to be as close as possible to the current implementation.
594594

595+
### Search extension result
596+
597+
Target that allows replacing search results coming from any search extensions.
598+
599+
![Search extension results](./assets/search-extension-result-doc.png "Search extension result")
600+
601+
#### Compatibility
602+
603+
| | |
604+
| ------------- | -------------------------------------- |
605+
| Target ID | `search-extension-result` |
606+
| Description | Target the search extension result. |
607+
| Placements | Compatible with placements: `REPLACE`. |
608+
| Disable | No compatibility. |
609+
| Changing text | No compatibility. |
610+
611+
**Note:** Using `context` it is possible to retrieve the full data of the search result.
612+
This, combined with RawHTML component, allows a full customization of the search result.
613+
595614
#### Use cases
596615

597616
- [Replace icons for a specific result type](./use-cases#replace-icons-for-a-specific-result-type)

0 commit comments

Comments
 (0)