HostedSearchPage
Disclaimer: This component was built by the community at large and is not an official Coveo JSUI Component. Use this component at your own risk.
Getting Started
- Install the component into your project.
npm i @coveops/hosted-search-page
- Use the Component or extend it
Typescript:
import { HostedSearchPage, IHostedSearchPageOptions } from '@coveops/hosted-search-page';
Javascript
const HostedSearchPage = require('@coveops/hosted-search-page').HostedSearchPage;
- You can also expose the component alongside other components being built in your project.
export * from '@coveops/hosted-search-page'
- Or for quick testing, you can add the script from unpkg
<script src="https://unpkg.com/@coveops/hosted-search-page@latest/dist/index.min.js"></script>
Disclaimer: Unpkg should be used for testing but not for production.
- Include the component in your template as follows:
Place the component in your markup:
<hosted-search-page id="hsp"></hosted-search-page>
<script>
var hostedSearchPage = document.getElementById('hsp');
hostedSearchPage.configure({
orgId: 'YOUR_COVEO_ORG_ID',
apiKey: 'YOUR_SEARCH_PAGES_API_KEY',
pageId: 'YOUR_HOSTED_SEARCH_PAGE_ID'
});
document.addEventListener('CoveoScriptsLoaded', function () {
Coveo.SearchEndpoint.configureCloudV2Endpoint('YOUR_COVEO_ORG_ID', 'YOUR_TOKEN');
Coveo.init(hostedSearchPage.searchPage.querySelector('.CoveoSearchInterface'), {});
});
</script>
Extending
Extending the component can be done as follows:
import { HostedSearchPage, IHostedSearchPageOptions } from "@coveops/hosted-search-page";
export interface IExtendedHostedSearchPageOptions extends IHostedSearchPageOptions {}
export class ExtendedHostedSearchPage extends HostedSearchPage {}
Contribute
- Clone the project
- Copy
.env.dist
to.env
and update the COVEO_ORG_ID and COVEO_TOKEN fields in the.env
file to use your Coveo credentials and SERVER_PORT to configure the port of the sandbox - it will use 8080 by default. - Build the code base:
npm run build
- Serve the sandbox for live development
npm run serve