npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@coveops/context-dropdown

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

470

Readme

ContextDropdown

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.

Allows a user to select a context value via a dropdown to pass to Coveo for relevance tuning.

Getting Started

  1. Install the component into your project.
npm i @coveops/context-dropdown
  1. Use the Component or extend it

Typescript:

import { ContextDropdown, IContextDropdownOptions } from '@coveops/context-dropdown';

Javascript

const ContextDropdown = require('@coveops/context-dropdown').ContextDropdown;
  1. You can also expose the component alongside other components being built in your project.
export * from '@coveops/context-dropdown'
  1. Or for quick testing, you can add the script from unpkg
<script src="https://unpkg.com/@coveops/context-dropdown@latest/dist/index.min.js"></script>

Disclaimer: Unpkg should be used for testing but not for production.

  1. Include the component in your template as follows:

Place the component in your markup:

<div class="CoveoContextDropdown"></div>

Options

The following options can be configured:

| Option | Required | Type | Default | Notes | | --- | --- | --- | --- | --- | | contextKey | Yes | string | | The name of the context field to pass the value to. | | values | Yes | IOption[] or IGroupedOption[] | | An array of objects formatted to be an option or group depending on the isGrouped value | | isGrouped | No | boolean | false | Whether the values passed represent options divided into groups | | initialChoice | No | string | | An initial option to be automatically selected by the dropdown | | triggerSearch | No | boolean | false | Whether to trigger a search query when the value is changed. Note: Setting this to true will incur a query every time a user changes the value of this component and will impact your QPM. Please ensure there is no impact on your QPM or make necessary adjustments before setting this value to true. |

Examples found in /pages/index.html

Extending

Extending the component can be done as follows:

import { ContextDropdown, IContextDropdownOptions } from "@coveops/context-dropdown";

export interface IExtendedContextDropdownOptions extends IContextDropdownOptions {}

export class ExtendedContextDropdown extends ContextDropdown {}

Contribute

  1. Clone the project
  2. 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.
  3. Build the code base: npm run build
  4. Serve the sandbox for live development npm run serve