@coveops/have-you-tried
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

have-you-tried

When you have no results, have you tried will show machine learning query suggestions to try.

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

  1. Install the component into your project.
npm i @coveops/have-you-tried
  1. Use the Component or extend it

Typescript:

import { HaveYouTried, IHaveYouTriedOptions } from '@coveops/have-you-tried';

Javascript

const have-you-tried = require('@coveops/have-you-tried').HaveYouTried;
  1. You can also expose the component alongside other components being built in your project.
export * from '@coveops/have-you-tried'
  1. Include the component in your template as follows:
<div class="CoveoHaveYouTried"></div>

Options

The following options can be configured:

Option Required Type Default Notes
title No string <b>No results?</b> You can also try: Title rendered

Extending

Extending the component can be done as follows:

import { HaveYouTried, IHaveYouTriedOptions } from "@coveops/have-you-tried";

export interface IExtendedHaveYouTriedOptions extends IHaveYouTriedOptions {}

export class ExtendedHaveYouTried extends HaveYouTried {}

The following methods can be extended to provide additional functionalities or handle more complex use cases.

applyCommunityUrlRewriter

protected renderTitle():string

The renderTitle should render the title for the component.

Contribute

  1. Clone the project
  2. 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.
  3. Build the code base: npm run build
  4. Serve the sandbox for live development npm run serve

Dependencies (2)

Dev Dependencies (1)

Package Sidebar

Install

npm i @coveops/have-you-tried

Weekly Downloads

1

Version

1.0.0

License

Apache-2.0

Unpacked Size

40.6 kB

Total Files

9

Last publish

Collaborators

  • cfosscoveo
  • belbizri
  • jantoun_coveo
  • ehsanshahneh
  • watallah
  • coveoit
  • gfoumbi
  • rvundavalli
  • sfecteau
  • jfleurent
  • eqcoveo
  • jmdro
  • davebouffard
  • jfallaire
  • achouan
  • hsinghcoveo
  • elafleur_coveo
  • plavigueur
  • eaubin
  • lpblais-coveo