Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit d1d2598

Browse files
committed
Popover only works with Luma
Added callout to explains that the popover only works with the Luma theme, or with customized themes derived from Luma. Added a new section with a section of code that must not be modified.
1 parent ecfc3e6 commit d1d2598

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/live-search/storefront-popover.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ When Live Search is installed, a popover appears in the storefront as shoppers t
77

88
Live Search returns results for a query of two characters or more. For a partial match, the maximum number of characters per word is 20. The number of characters in a "search as you type" query is not configurable.
99

10+
{:.bs-callout-info}
11+
The Live Search storefront popover is available only for stores that use the _Luma_ theme, or a customized theme that is based on _Luma_. The _Luma_ theme is included in the Commerce sample data. The popover does not support the _Blank_ theme. See [Working with a modified theme](#working-with-a-modified-theme) for more information.
12+
13+
## Searchable attributes
14+
1015
The following attributes are always searchable:
1116

1217
- `sku`
@@ -81,6 +86,20 @@ _.livesearch.product-name_
8186
![Product price]({{ page.baseurl }}/live-search/images/livesearch-product-price.png)
8287
_.livesearch.product-price_
8388

89+
## Working with a modified theme
90+
91+
The storefront popover can be used with a customized [theme](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/themes/theme-overview.html) that inherits the required files from _Luma_. The `top.search` block in the `header-wrapper` of the `Magento_Search` module must not be modified.
92+
93+
```html
94+
<referenceContainer name="header-wrapper">
95+
<block class="Magento\Framework\View\Element\Template" name="top.search" as="topSearch" template="Magento_Search::form.mini.phtml">
96+
<arguments>
97+
<argument name="configProvider" xsi:type="object">Magento\Search\ViewModel\ConfigProvider</argument>
98+
</arguments>
99+
</block>
100+
</referenceContainer>
101+
```
102+
84103
## Disabling the popover
85104

86105
To disable the popover and restore standard [Quick Search](https://docs.magento.com/user-guide/catalog/search-quick.html) functionality, enter the following command:

0 commit comments

Comments
 (0)