@coveops/tab-reset-facets
v1.1.0
Published
Resets the state of the search interface when a tab is selected
Downloads
37
Maintainers
Keywords
Readme
TabResetFacets
Resets the state of the search interface when a tab is selected.
The component will find all Facet
and DynamicFacet
components on the page and trigger their respective reset
method.
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/tab-reset-facets
- Use the Component or extend it
Typescript:
import { TabResetFacets, ITabResetFacetsOptions } from '@coveops/tab-reset-facets';
Javascript
const TabResetFacets = require('@coveops/tab-reset-facets').TabResetFacets;
- You can also expose the component alongside other components being built in your project.
export * from '@coveops/tab-reset-facets'
- Or for quick testing, you can add the script from unpkg
<script src="https://unpkg.com/@coveops/tab-reset-facets@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 after the CoveoSearchInterface
initialization.
<div class="CoveoTabResetFacets"></div>
Example:
<div id="search" class="CoveoSearchInterface" data-enable-history="true">
<div class="CoveoTabResetFacets"></div>
Extending
Extending the component can be done as follows:
import { TabResetFacets, ITabResetFacetsOptions } from "@coveops/tab-reset-facets";
export interface IExtendedTabResetFacetsOptions extends ITabResetFacetsOptions {}
export class ExtendedTabResetFacets extends TabResetFacets {}
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