Getting Started with searchstudio-UX-JS

The SearchStax Site Search solution includes a JavaScript package to help you assemble a custom search page.

Example

For a full example, see searchstudio-ux-js.

Installation

1
npm install --save @searchstax-inc/searchstudio-ux-js

Import

Import the Searchstax class into your code:

1
import Searchstax from '@searchstax-inc/searchstudio-ux-js';

Instantiation

Create a new instance of the Searchstax class:

1
const searchstax = new Searchstax();

Initialization

Initialize the Searchstax instance by passing a configuration object:

1
2
3
searchstax.initialize({
  // options
});

See the Configuration section for details on the options available.

Widgets

Add widgets by invoking the respective add methods:

1
2
3
searchstax.addSearchInputWidget({/* options */});
searchstax.addSearchResultsWidget({/* options */});
// etc

Refer to the Widgets section for details on each widget.

Styles

Import the default CSS styles:

1
@import '@searchstax-inc/searchstudio-ux-js/dist/styles/mainTheme.css';

See the Styling section for information on theming and customization.