@coveops/dependent-hierarchical-facet
v1.0.0
Published
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.
Downloads
3
Maintainers
Keywords
Readme
DependentHierarchicalFacet
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/dependent-hierarchical-facet
- Use the Component or extend it
Typescript:
import { DependentHierarchicalFacet, IDependentHierarchicalFacetOptions } from '@coveops/dependent-hierarchical-facet';
Javascript
const DependentHierarchicalFacet = require('@coveops/dependent-hierarchical-facet').DependentHierarchicalFacet;
- You can also expose the component alongside other components being built in your project.
export * from '@coveops/dependent-hierarchical-facet'
- Include the component in your template as follows:
Place the component in your markup amongst your other facets under coveo-facet-column
<div class="CoveoDependentHierarchicalFacet"></div>
Extending
Extending the component can be done as follows:
import { DependentHierarchicalFacet, IDependentHierarchicalFacetOptions } from "@coveops/dependent-hierarchical-facet";
export interface IExtendedDependentHierarchicalFacetOptions extends IDependentHierarchicalFacetOptions {}
export class ExtendedDependentHierarchicalFacet extends DependentHierarchicalFacet {}
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