@searchstax-inc/searchstudio-ux-js 0.0.7 → 0.0.8

package/README.md

@@ -29,14 +29,23 @@ After importing Searchstax class a new instance needs to be created:
 
 ## Initialization
 Initialization object
+
 {
+
   `language: string;` - language code. Example: 'en'
+
   `searchURL: string;` - SeachStudio select endpoint
+
   `suggesterURL: string;` - SeachStudio suggest endpoint
+
   `trackApiKey: string;` - Api key used for tracking events
+
   `searchAuth: string;` - Authentication value. based on authType it's either a token value or basic auth value
+
   `authType: 'token' | 'basic';` - Type of authentication
+
 }
+
 Initialization example
 ```
 searchstax.initialize({
@@ -52,20 +61,35 @@ searchstax.initialize({
 
 ## Input widget
 Initialization properties
+
 a. id of container where widget will be rendered
+
 b. {
+
   `suggestAfterMinChars: number;` - controls how many characters the UI should accept at the minimum before showing suggestions
+
   `templates?: {` - optional object that defines template override options
+
     `mainTemplate?: string;` - main template in Mustache templating language
+
     `searchInputId?: string;` - id of search input within the mainTemplate
+
     `autosuggestItemTemplate?: string;` - autosuggest item template in Mustache
+
   `};`
+
   `hooks?: {` - optional object that provides various hook options
+
     `beforeSearch?: (props: ISearchstaxSearchProps) => ISearchstaxSearchProps | null;` - this function gets called before firing search. searchProps are being passed as a property and can be modified, if passed along further search will execute with modified properties, if null is returned then event gets canceled and search never fires.
+
     `afterSearch?: (results: ISearchstaxParsedResult[]) => ISearchstaxParsedResult[];` - this function gets called after firing search and before rendering. It needs to return array of results that are either modified or untouched.
+
     `beforeAutosuggest?: (props: ISearchstaxSuggestProps) => ISearchstaxSuggestProps | null;` - this function gets called before firing autosuggest. autosuggestProps are being passed as a property and can be modified, if passed along further search will execute with modified properties, if null is returned then event gets canceled and search never fires.
+
     `afterAutosuggest?: (result: ISearchstaxSuggestResponse) => ISearchstaxSuggestResponse;`- this function gets called after autosuggest has values but before rendering. It needs to return same type of data but it can be modified.
+
   `};`
+
 }
 
 
@@ -110,17 +134,29 @@ example of input widget initialization with various options
 ```
 ## Result widget
 Initialization properties
+
 a. id of container where widget will be rendered
+
 b. {
+
   `searchResultsContainerId?: string;` - this is needed only if mainTemplate is overridden. It points to an element in the template where results need to be rendered
+
   `searchResultUniqueIdAttribute?: string;` - this is needed only if searchResultTemplate is overridden. searchResultTemplate needs to have unique result id property. Default is data-searchstax-unique-result-id="{{uniqueId}}". see example below on how it is used
+
   `templates?: {` - optional object that defines template override options
+
     `mainTemplate?: string;` - main template in Mustache templating language.
+
     `searchResultTemplate?: string;` - result template using Mustache. ISearchstaxParsedResult is passed to the template and all its properties are available to be used when rendering
+
     `noSearchResultTemplate?: string;` - Mustache template for no results section override. spellingSuggestion and searchTerm are values available in the template
+
   `};`
+
   `hooks?: {` - optional object that provides various hook options
+
     `afterLinkClick?: (resultClicked: ISearchstaxParsedResult) => ISearchstaxParsedResult | null;` - function is called after user clicks result and passes that result as a property. when result is passed along tracking will execute and user will be navigated if null is returned events are canceled and nothing happens.
+
   `};`
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@searchstax-inc/searchstudio-ux-js",
   "private": false,
-  "version": "0.0.7",
+  "version": "0.0.8",
   "files": [
     "dist"
   ],