Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/replace searchbox #415

Open
wants to merge 12 commits into
base: dev
Choose a base branch
from
2 changes: 1 addition & 1 deletion content/docs/analytics/google-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ If you only want to track your searchbox and you are using the [DataSearch](http
### ReactiveSearch Vue
If you want to track your searchbox and you are using the [data-search](https://docs.appbase.io/docs/reactivesearch/vue/search/DataSearch/) component for it, you can do the following.

```vue
```html
<data-search
@valueChange="
function(value) {
Expand Down
10 changes: 6 additions & 4 deletions content/docs/pipelines/API/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ Trigger will indicate whether or not to trigger the stage.

#### Trigger Expression

Custom trigger expression. You can read more at [here](https://docs.appbase.io/docs/search/rules/#advanced-editor).
Custom trigger expression. You can read more at [here](https://docs.reactivesearch.io/docs/search/rules/#advanced-editor).

### Pre-built Stage

Expand All @@ -267,7 +267,7 @@ Use a pre-built stage from Appbase.

## Trigger Expression

Trigger expression is to define the condition of Pipeline invocation. For example, only execute pipeline if query is \'mobile phone\'. Check the documentation at [here](https://docs.appbase.io/docs/search/rules/#configure-if-condition).
Trigger expression is to define the condition of Pipeline invocation. For example, only execute pipeline if query is \'mobile phone\'. Check the documentation at [here](https://docs.reactivesearch.io/docs/search/rules/#configure-if-condition).

Following is an example trigger for a pipeline that searches for mobile phones:

Expand All @@ -281,7 +281,7 @@ Above trigger will **always** run and execute the expression provided to it.

### Trigger Expression

Custom trigger expression. You can read more at [here](https://docs.appbase.io/docs/search/rules/#advanced-editor).
Custom trigger expression. You can read more at [here](https://docs.reactivesearch.io/docs/search/rules/#advanced-editor).

### Timeframe

Expand All @@ -293,9 +293,11 @@ To define the valid timeframe for trigger expression.

### Trigger Type

Type of trigger expression. You can read more at [here](https://docs.appbase.io/docs/search/rules/#configure-if-condition).
Type of trigger expression. You can read more at [here](https://docs.reactivesearch.io/docs/search/rules/#configure-if-condition).

**Following values are supported for this field**

`always`, `filter`, `index`, `query`, `cron`

## validateContext

4 changes: 2 additions & 2 deletions content/docs/reactivesearch/vue/list/TreeList.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Example uses:

### Usage (with all props)

```vue
```html
<TreeList
componentId="TreeListComponent"
mode="multiple"
Expand All @@ -61,7 +61,7 @@ Example uses:

### Usage (as a controlled component)

```vue
```html
<template>
<TreeList
componentId="TreeListComponent"
Expand Down
25 changes: 20 additions & 5 deletions content/docs/search/reactivesearch-api/reference/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ For example, the below query has two data fields defined and each field has a di
| ------------ | --------------------------- | -------- |
| `Array<int>` | `search`,`suggestion` | false |

> Note: The `fieldWeights` property has been marked as deprecated in <b>v7.47.0</b> and would be removed in the next major version of appbase.io. We recommend you to use the [dataField](/docs/search/reactivesearch-api/reference/#datafield) property to define the weights.
> Note: The `fieldWeights` property has been marked as deprecated in <b>v7.47.0</b> and would be removed in the next major version of reactivesearch.io. We recommend you to use the [dataField](/docs/search/reactivesearch-api/reference/#datafield) property to define the weights.

### nestedField

Expand Down Expand Up @@ -572,7 +572,7 @@ Useful for showing the correct results for an incorrect search parameter by taki

| <p style="margin: 0px;" class="table-header-text">Type</p> | <p style="margin: 0px;" class="table-header-text">Applicable on query of type</p> | <p style="margin: 0px;" class="table-header-text">Required</p> |
| -------------- | --------------------------- | -------- |
| `int | string` | `search`, `suggestion` | false |
| `int, string` | `search`, `suggestion` | false |

> Note:
>
Expand Down Expand Up @@ -1583,6 +1583,21 @@ When featured suggestions are enabled, set the value of the `searchboxId` to use
**Supported Engines**
elasticsearch, opensearch

### Compound Clause

**Supported Engines**
opensearch, elasticsearch

### enableDocumentSuggestions

**Supported Engines**
elasticsearch, opensearch

### documentSuggestionsConfig

**Supported Engines**
elasticsearch, opensearch

## settings

**Supported Engines**
Expand All @@ -1593,21 +1608,21 @@ Not dependent on engine, works for all.
**Supported Engines**
elasticsearch, solr, opensearch

`bool` defaults to `false`. If `true` then it'll enable the recording of Appbase.io analytics.
`bool` defaults to `false`. If `true` then it'll enable the recording of ReactiveSearch.io analytics.

### userId

**Supported Engines**
elasticsearch, opensearch

`String` It allows you to define the user id which will be used to record the Appbase.io analytics.
`String` It allows you to define the user id which will be used to record the ReactiveSearch.io analytics.

### customEvents

**Supported Engines**
elasticsearch, opensearch

`Object` It allows you to set the custom events which can be used to build your own analytics on top of the Appbase.io analytics. Further, these events can be used to filter the analytics stats from the Appbase.io dashboard. In the below example, we\'re setting up two custom events that will be recorded with each search request.
`Object` It allows you to set the custom events which can be used to build your own analytics on top of the ReactiveSearch.io analytics. Further, these events can be used to filter the analytics stats from the ReactiveSearch.io dashboard. In the below example, we\'re setting up two custom events that will be recorded with each search request.

```js
{
Expand Down
25 changes: 20 additions & 5 deletions content/docs/search/reactivesearch-api/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ For example, the below query has two data fields defined and each field has a di
| ------------ | --------------------------- | -------- |
| `Array<int>` | `search`,`suggestion` | false |

> Note: The `fieldWeights` property has been marked as deprecated in <b>v7.47.0</b> and would be removed in the next major version of appbase.io. We recommend you to use the [dataField](/docs/search/reactivesearch-api/reference/#datafield) property to define the weights.
> Note: The `fieldWeights` property has been marked as deprecated in <b>v7.47.0</b> and would be removed in the next major version of reactivesearch.io. We recommend you to use the [dataField](/docs/search/reactivesearch-api/reference/#datafield) property to define the weights.

### nestedField

Expand Down Expand Up @@ -573,7 +573,7 @@ Useful for showing the correct results for an incorrect search parameter by taki

| <p style="margin: 0px;" class="table-header-text">Type</p> | <p style="margin: 0px;" class="table-header-text">Applicable on query of type</p> | <p style="margin: 0px;" class="table-header-text">Required</p> |
| -------------- | --------------------------- | -------- |
| `int | string` | `search`, `suggestion` | false |
| `int, string` | `search`, `suggestion` | false |

> Note:
>
Expand Down Expand Up @@ -1584,6 +1584,21 @@ When featured suggestions are enabled, set the value of the `searchboxId` to use
**Supported Engines**
elasticsearch, opensearch

### Compound Clause

**Supported Engines**
opensearch, elasticsearch

### enableDocumentSuggestions

**Supported Engines**
elasticsearch, opensearch

### documentSuggestionsConfig

**Supported Engines**
elasticsearch, opensearch

## settings

**Supported Engines**
Expand All @@ -1594,21 +1609,21 @@ Not dependent on engine, works for all.
**Supported Engines**
elasticsearch, solr, opensearch

`bool` defaults to `false`. If `true` then it'll enable the recording of Appbase.io analytics.
`bool` defaults to `false`. If `true` then it'll enable the recording of ReactiveSearch.io analytics.

### userId

**Supported Engines**
elasticsearch, opensearch

`String` It allows you to define the user id which will be used to record the Appbase.io analytics.
`String` It allows you to define the user id which will be used to record the ReactiveSearch.io analytics.

### customEvents

**Supported Engines**
elasticsearch, opensearch

`Object` It allows you to set the custom events which can be used to build your own analytics on top of the Appbase.io analytics. Further, these events can be used to filter the analytics stats from the Appbase.io dashboard. In the below example, we\'re setting up two custom events that will be recorded with each search request.
`Object` It allows you to set the custom events which can be used to build your own analytics on top of the ReactiveSearch.io analytics. Further, these events can be used to filter the analytics stats from the ReactiveSearch.io dashboard. In the below example, we\'re setting up two custom events that will be recorded with each search request.

```js
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ Useful for showing the correct results for an incorrect search parameter by taki

| <p style="margin: 0px;" class="table-header-text">Type</p> | <p style="margin: 0px;" class="table-header-text">Applicable on query of type</p> | <p style="margin: 0px;" class="table-header-text">Required</p> |
| -------------- | --------------------------- | -------- |
| `int | string` | `search`, `suggestion` | false |
| `int, string` | `search`, `suggestion` | false |

> Note:
>
Expand Down
25 changes: 20 additions & 5 deletions content/docs/search/reactivesearch-api/reference/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ For example, the below query has two data fields defined and each field has a di
| ------------ | --------------------------- | -------- |
| `Array<int>` | `search`,`suggestion` | false |

> Note: The `fieldWeights` property has been marked as deprecated in <b>v7.47.0</b> and would be removed in the next major version of appbase.io. We recommend you to use the [dataField](/docs/search/reactivesearch-api/reference/#datafield) property to define the weights.
> Note: The `fieldWeights` property has been marked as deprecated in <b>v7.47.0</b> and would be removed in the next major version of reactivesearch.io. We recommend you to use the [dataField](/docs/search/reactivesearch-api/reference/#datafield) property to define the weights.

### nestedField

Expand Down Expand Up @@ -572,7 +572,7 @@ Useful for showing the correct results for an incorrect search parameter by taki

| <p style="margin: 0px;" class="table-header-text">Type</p> | <p style="margin: 0px;" class="table-header-text">Applicable on query of type</p> | <p style="margin: 0px;" class="table-header-text">Required</p> |
| -------------- | --------------------------- | -------- |
| `int | string` | `search`, `suggestion` | false |
| `int, string` | `search`, `suggestion` | false |

> Note:
>
Expand Down Expand Up @@ -1614,6 +1614,21 @@ The fields supported by the AIConfig object are:
- **minTokens**: Minimum number of tokens to generate in the response. Whenever possible, max tokens is respected, however when the input context + max tokens combined exceed the model limit, the min tokens value is used to calibrate for an optimum output token. Defaults to 100.
- **temperature**: A control for randomness, a lower value implies a more deterministic output. Defaults to 1, valid values are between [0, 2].

### Compound Clause

**Supported Engines**
opensearch, elasticsearch

### enableDocumentSuggestions

**Supported Engines**
elasticsearch, opensearch

### documentSuggestionsConfig

**Supported Engines**
elasticsearch, opensearch

## settings

**Supported Engines**
Expand All @@ -1624,21 +1639,21 @@ Not dependent on engine, works for all.
**Supported Engines**
elasticsearch, solr, opensearch

`bool` defaults to `false`. If `true` then it'll enable the recording of Appbase.io analytics.
`bool` defaults to `false`. If `true` then it'll enable the recording of ReactiveSearch.io analytics.

### userId

**Supported Engines**
elasticsearch, opensearch

`String` It allows you to define the user id which will be used to record the Appbase.io analytics.
`String` It allows you to define the user id which will be used to record the ReactiveSearch.io analytics.

### customEvents

**Supported Engines**
elasticsearch, opensearch

`Object` It allows you to set the custom events which can be used to build your own analytics on top of the Appbase.io analytics. Further, these events can be used to filter the analytics stats from the Appbase.io dashboard. In the below example, we\'re setting up two custom events that will be recorded with each search request.
`Object` It allows you to set the custom events which can be used to build your own analytics on top of the ReactiveSearch.io analytics. Further, these events can be used to filter the analytics stats from the ReactiveSearch.io dashboard. In the below example, we\'re setting up two custom events that will be recorded with each search request.

```js
{
Expand Down
2 changes: 1 addition & 1 deletion content/docs/search/reactivesearch-api/reference/solr.md
Original file line number Diff line number Diff line change
Expand Up @@ -924,7 +924,7 @@ Not dependent on engine, works for all.
**Supported Engines**
elasticsearch, solr, opensearch

`bool` defaults to `false`. If `true` then it'll enable the recording of Appbase.io analytics.
`bool` defaults to `false`. If `true` then it'll enable the recording of ReactiveSearch.io analytics.

### backend

Expand Down
1 change: 0 additions & 1 deletion gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ const plugins = [
html: 'html',
sh: 'bash',
curl: 'bash',
vue: 'vue',
},
},
},
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"dependencies": {
"@appbaseio/designkit": "^0.13.0",
"@appbaseio/reactivemaps": "^3.0.0",
"@appbaseio/reactivesearch": "^3.30.3",
"@appbaseio/reactivesearch": "^4.1.0-alpha.11",
"@loadable/component": "^5.15.2",
"@reach/router": "^1.2.1",
"@typeform/embed": "^1.34.1",
Expand Down Expand Up @@ -115,6 +115,7 @@
"react-dom": "^16.9.0",
"react-dropdown": "^1.6.4",
"react-helmet": "^6.0.0",
"react-icons": "^4.10.1",
"react-modal": "3.8.1",
"react-responsive-modal": "^4.0.1",
"react-router": "^6.0.1",
Expand Down
Loading