@ai12z/react 0.0.1-alpha.66 → 0.0.1-alpha.67
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.
- package/README.md +25 -25
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -35,8 +35,9 @@ We are providing the option named as **dataAttributes** for assigning the JSON o
|
|
|
35
35
|
]
|
|
36
36
|
}
|
|
37
37
|
};
|
|
38
|
-
</script>
|
|
38
|
+
</script>
|
|
39
39
|
```
|
|
40
|
+
|
|
40
41
|
# Setup
|
|
41
42
|
|
|
42
43
|
To install from npm
|
|
@@ -63,35 +64,34 @@ import { Ai12zCta, Ai12zKnowledgeBox } from '@ai12z/react'
|
|
|
63
64
|
<cta></cta>
|
|
64
65
|
</Ai12zCta>
|
|
65
66
|
```
|
|
67
|
+
|
|
66
68
|
- **<privacy></privacy>** (Optional) This tag element allows us to add the privacy policy links.
|
|
67
69
|
- **<cta></cta>** (Optional) This tag element allows us to customize our page by adding our own tag elements within this element.
|
|
68
70
|
|
|
69
|
-
|
|
70
71
|
- The control contains following properties to customize the page.
|
|
71
72
|
|
|
72
|
-
| Property
|
|
73
|
-
|
|
74
|
-
| dataKey (Required)
|
|
75
|
-
| dataMode (Required)
|
|
76
|
-
| heading (Optional)
|
|
77
|
-
| buttonText (Optional)
|
|
78
|
-
| helpText (Optional)
|
|
79
|
-
| noResultsText (Optional) |
|
|
80
|
-
| autoSearch (Optional)
|
|
81
|
-
| placeholder (Optional)
|
|
82
|
-
| iconSrc (Optional)
|
|
83
|
-
| categorize (Optional)
|
|
84
|
-
| clearMemory (Optional)
|
|
85
|
-
| imageUpload (Optional)
|
|
73
|
+
| Property | Description | Example |
|
|
74
|
+
| ------------------------ | :-----------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------: |
|
|
75
|
+
| dataKey (Required) | API key from your ai12z project settings | dataKey="123456" |
|
|
76
|
+
| dataMode (Required) | Allows us to enter the data-mode which will identify the server as local or dev or prod | dataMode="dev" |
|
|
77
|
+
| heading (Optional) | Allows us to show the header text | heading="Search Here 1" |
|
|
78
|
+
| buttonText (Optional) | Allows us to customize the button name | buttonText="Ask me" |
|
|
79
|
+
| helpText (Optional) | Allows us to customize the helper text | helpText="Type your question here..." |
|
|
80
|
+
| noResultsText (Optional) | allows us to customize the no results found text | noResultsText="No results found..." |
|
|
81
|
+
| autoSearch (Optional) | allows us to configure the search option | autoSearch="true" |
|
|
82
|
+
| placeholder (Optional) | allows us to customize the placeholder text | placeholder="Enter the text" |
|
|
83
|
+
| iconSrc (Optional) | allows us to add the icon to the search button along with the text or icon only | icon-src= "https://uxwing.com/wp-content/themes/uxwing/download/user-interface/magnifying-glass-icon.png?w=24&h=24" |
|
|
84
|
+
| categorize (Optional) | allows us to customize the search results based on the category. By default the search results will be catogorized. | categorize = "true" |
|
|
85
|
+
| clearMemory (Optional) | allows us to clear the previously searched data. By defualt, this property is set to true | clearMemory={true} |
|
|
86
|
+
| imageUpload (Optional) | allows us to perform a image based search.By default, this property is set to true | imageUpload={true} |
|
|
86
87
|
|
|
87
88
|
- 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.
|
|
88
89
|
|
|
89
|
-
| Property
|
|
90
|
-
|
|
91
|
-
| dataKey (Required)
|
|
92
|
-
| dataMode (Required)
|
|
93
|
-
| question (Required)
|
|
94
|
-
| relavanceScore (Optional) |
|
|
95
|
-
| feedback (Optional)
|
|
96
|
-
| clearMemory (Optional)
|
|
97
|
-
|
|
90
|
+
| Property | Description | Example |
|
|
91
|
+
| ------------------------- | :--------------------------------------------------------------------------------------------------------: | ----------------------------: |
|
|
92
|
+
| dataKey (Required) | API key from your ai12z project settings | dataKey="123456" |
|
|
93
|
+
| dataMode (Required) | Allows us to enter the data-mode which will identify the server as local or dev or prod | dataMode="dev" |
|
|
94
|
+
| question (Required) | Allows us to set the question for on-load | question="what does ai12z do" |
|
|
95
|
+
| relavanceScore (Optional) | allows us to view the score of clicks, engagement, conversions and negative reviews. | relavanceScore="true" |
|
|
96
|
+
| feedback (Optional) | allows us to add the thumbs up and down option for the questions. By default, this property is set to true | feedback="true" |
|
|
97
|
+
| clearMemory (Optional) | allows us to clear the previously searched data. By defualt, this property is set to true | clearMemory="true" |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ai12z/react",
|
|
3
|
-
"version": "0.0.1-alpha.
|
|
3
|
+
"version": "0.0.1-alpha.67",
|
|
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": "
|
|
36
|
+
"gitHead": "49b0c94280eb46c011d2f1fd09821366865961e9"
|
|
37
37
|
}
|