@coveops/clear-bit-logo
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
4
Maintainers
Keywords
Readme
ClearBitLogo
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/clear-bit-logo
- Use the Component or extend it
Typescript:
import { ClearBitLogo, IClearBitLogoOptions } from '@coveops/clear-bit-logo';
Javascript
const ClearBitLogo = require('@coveops/clear-bit-logo').ClearBitLogo;
- You can also expose the component alongside other components being built in your project.
export * from '@coveops/clear-bit-logo'
- Include the component in your template as follows:
Place the component after the last tab in the coveo-tab-section
<div class="CoveoClearBitLogo"></div>
Extending
Extending the component can be done as follows:
import { ClearBitLogo, IClearBitLogoOptions } from "@coveops/clear-bit-logo";
export interface IExtendedClearBitLogoOptions extends IClearBitLogoOptions {}
export class ExtendedClearBitLogo extends ClearBitLogo {}
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