Skip to content

Commit

Permalink
suggestions - add before you begin, compact table
Browse files Browse the repository at this point in the history
  • Loading branch information
julia-rabello committed Jan 23, 2024
1 parent 648dd7e commit df0dd04
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/Suggestions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

`Suggestions` is a component used to suggest search terms similar to the current query.

## Before you begin

Make sure you have added the `search` app to your theme dependencies in the `manifest.json` as shown below:

```json
"dependencies": {
"vtex.search": "2.x"
}
```

Check the [Search](https://developers.vtex.com/docs/apps/vtex.search) app documentation for more details on this step.

## Usage

Add the `search-suggestions` block to the `search-result-layout.desktop` or `search-result-layout.mobile`. For example:
Expand All @@ -19,9 +31,9 @@ Add the `search-suggestions` block to the `search-result-layout.desktop` or `sea

### Props

| Prop name | Type | Description | Default value |
| ------------ | -------- | -------------------------------------------------------------------------------------------------------------- | ------------- |
| `customPage` | `string` | Defines a custom page to the link of a suggestion. Example: `store.search.custom`. Defaults to `store.search`. | |
| Prop name | Type | Description | Default value |
| - | - | - | - |
| `customPage` | `string` | Defines a custom page to the link of a suggestion. Example: `store.search.custom`. | `store.search` |

## Customization

Expand Down

0 comments on commit df0dd04

Please sign in to comment.