@coveops/reset-tabs
v1.0.1
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
5
Maintainers
Keywords
Readme
ResetTabs
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/reset-tabs
- Use the Component or extend it
Typescript:
import { ResetTabs, IResetTabsOptions } from '@coveops/reset-tabs';
Javascript
const ResetTabs = require('@coveops/reset-tabs').ResetTabs;
- You can also expose the component alongside other components being built in your project.
export * from '@coveops/reset-tabs'
- Or for quick testing, you can add the script from unpkg
<script src="https://unpkg.com/@coveops/reset-tabs@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:
<div class="CoveoResetTabs"></div>
Options
The following options can be configured:
| Option | Required | Type | Default | Notes |
| --- | --- | --- | --- | --- |
| defaultTabId
| No | string | All
| The tab id that we will reset to. The value of this option is case-sensitive. |
Extending
Extending the component can be done as follows:
import { ResetTabs, IResetTabsOptions } from "@coveops/reset-tabs";
export interface IExtendedResetTabsOptions extends IResetTabsOptions {}
export class ExtendedResetTabs extends ResetTabs {}
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