@coveops/show-if-field-value
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
ShowIfFieldValue
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.
Purpose:
In a Result Template, show or hide markup if a specified field and value matches the component's options.
Options:
- field: field you want to display on the result template
- fieldValue: the value to match for the content of the element to be displayed
<div class="CoveoShowIfFieldValue" data-field="@filetype" data-field-value="lithiummessage">
show this message if result's @filetype field value is "lithiummessage"
</div>
Getting Started
- Install the component into your project.
npm i @coveops/show-if-field-value
- Use the Component or extend it
Typescript:
import { ShowIfFieldValue, IShowIfFieldValueOptions } from '@coveops/show-if-field-value';
Javascript
const ShowIfFieldValue = require('@coveops/show-if-field-value').ShowIfFieldValue;
- You can also expose the component alongside other components being built in your project.
export * from '@coveops/show-if-field-value'
- Or for quick testing, you can add the script from unpkg
<script src="https://unpkg.com/@coveops/show-if-field-value@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, inside a Result Template:
<div class="CoveoShowIfFieldValue"></div>
Extending
Extending the component can be done as follows:
import { ShowIfFieldValue, IShowIfFieldValueOptions } from "@coveops/show-if-field-value";
export interface IExtendedTestComponentOptions extends IShowIfFieldValueOptions {}
export class ExtendedTestComponent extends ShowIfFieldValue {}
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