@coveops/results-per-page-dropdown
v1.0.2
Published
The `ResultsPerPageDropdown` component renders a dropdown that the end user can interact with to select the criteria to to choose how many results to display per page.
Downloads
3
Maintainers
Keywords
Readme
ResultsPerPageDropdown
The ResultsPerPageDropdown
component renders a dropdown that the end user can interact with to select the criteria to to choose how many results to display per page.
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/results-per-page-dropdown
- Use the Component or extend it
Typescript:
import { ResultsPerPageDropdown, IResultsPerPageDropdownOptions } from '@coveops/results-per-page-dropdown';
Javascript
const ResultsPerPageDropdown = require('@coveops/results-per-page-dropdown').ResultsPerPageDropdown;
- You can also expose the component alongside other components being built in your project.
export * from '@coveops/results-per-page-dropdown'
- Or for quick testing, you can add the script from unpkg
<script src="https://unpkg.com/@coveops/results-per-page-dropdown@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:
<div class="CoveoResultsPerPageDropdown"></div>
Extending
Extending the component can be done as follows:
import { ResultsPerPageDropdown, IResultsPerPageDropdownOptions } from "@coveops/results-per-page-dropdown";
export interface IExtendedResultsPerPageDropdownOptions extends IResultsPerPageDropdownOptions {}
export class ExtendedResultsPerPageDropdown extends ResultsPerPageDropdown {}
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