@ai12z/react 0.0.1-alpha.21 → 0.0.1-alpha.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -14
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -26,31 +26,37 @@ import { Ai12zCta, Ai12zKnowledgeBox } from '@ai12z/react'
26
26
  ```
27
27
 
28
28
  - Then you can use the element anywhere in your template.
29
- - The control named as **ai12z-cta** allows us to show the search results along with the follow up chat conversations and customize our search results.
29
+ - The control named as **Ai12zCta** allows us to show the search results along with the follow up chat conversations and customize our search results.
30
30
  - This control is having two tag element which is mentioned below.
31
31
 
32
32
  ```
33
- <privacy></privacy>
34
- <cta></cta>
33
+ <Ai12zCta>
34
+ <privacy></privacy>
35
+ <cta></cta>
36
+ </Ai12zCta>
35
37
  ```
36
- - **<privacy></privacy>** This tag element allows us to add the privacy policy links.
37
- - **<cta></cta>** This tag element allows us to customize our page by adding our own tag elements within this element.
38
+ - **<privacy></privacy>** (Optional) This tag element allows us to add the privacy policy links.
39
+ - **<cta></cta>** (Optional) This tag element allows us to customize our page by adding our own tag elements within this element.
38
40
 
39
41
 
40
42
  - The control contains following properties to customize the page.
41
43
 
42
44
  | Property | Description | Example |
43
45
  |-----------|:-----------:|-----------:|
44
- | data-key | Allows us to enter the data-key which is used by API | data-key="123456" |
45
- | data-mode | Allows us to enter the data-mode which will identify the server as local or dev or prod | data-mode="dev" |
46
- | heading | Allows us to show the header text | heading="Search Here 1" |
47
- | button-text | Allows us to customize the button name | button-text="Ask me" |
48
- | help-text | Allows us to customize the helper text | help-text="Type your question here..." |
49
- | no-results-text | allows us to customize the no results found text | no-results-text="No results found..." |
46
+ | dataKey (Required) | API key from your ai12z project settings | dataKey="123456" |
47
+ | dataMode (Required) | Allows us to enter the data-mode which will identify the server as local or dev or prod | dataMode="dev" |
48
+ | heading (Optional) | Allows us to show the header text | heading="Search Here 1" |
49
+ | buttonText (Optional) | Allows us to customize the button name | buttonText="Ask me" |
50
+ | helpText (Optional) | Allows us to customize the helper text | helpText="Type your question here..." |
51
+ | noResultsText (Optional) | allows us to customize the no results found text | noResultsText="No results found..." |
52
+ | autoSearch (Optional) | allows us to configure the search option | autoSearch="true" |
53
+ | placeholder (Optional) | allows us to customize the placeholder text | placeholder="Enter the text" |
50
54
 
51
- - The second control named as **ai12z-knowledge-box** allows us to send the query programmmatically through javascript and rendering the query results by clicking on the button.
55
+ - The second control named as **Ai12zKnowledgeBox** allows us to send the query programmmatically through javascript and rendering the query results by clicking on the button.
52
56
 
53
57
  | Property | Description | Example |
54
58
  |-----------|:-----------:|-----------:|
55
- | question | Allows us to set the question for on-load | question="what does ai12z do" |
56
- | relavance-score | allows us to view the score of clicks, engagement, conversions and negative reviews. | relavance-score="true" |
59
+ | dataKey (Required) | API key from your ai12z project settings | dataKey="123456" |
60
+ | dataMode (Required) | Allows us to enter the data-mode which will identify the server as local or dev or prod | dataMode="dev" |
61
+ | question (Required) | Allows us to set the question for on-load | question="what does ai12z do" |
62
+ | relavanceScore (Optional) | allows us to view the score of clicks, engagement, conversions and negative reviews. | relavanceScore="true" |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ai12z/react",
3
- "version": "0.0.1-alpha.21",
3
+ "version": "0.0.1-alpha.22",
4
4
  "description": "ai12z React Library",
5
5
  "author": "Alpesh Patel <alpesh@ai12z.com>",
6
6
  "homepage": "",
@@ -33,5 +33,5 @@
33
33
  "publishConfig": {
34
34
  "access": "public"
35
35
  },
36
- "gitHead": "4ec6094f5088180f1c72cf7fe47aee297f2467ab"
36
+ "gitHead": "23f1896288dca8ce09acd69676cefb0c91d1445f"
37
37
  }