# @coveops/context-dropdown

> 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.

Latest version **1.0.1** (published 2021-12-09) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @coveops/context-dropdown
pnpm add @coveops/context-dropdown
yarn add @coveops/context-dropdown
bun add @coveops/context-dropdown
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-12-09 |
| First published | 2021-12-09 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 33.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | watallah, czeng, coveoit, gfoumbi, rvundavalli, jwolfe-coveo, sfecteau, mthusscoveo, jfleurent, eqcoveo, jmdro, davebouffard, jfallaire, achouan, hsinghcoveo, wnijmeijer, lgcarrierbedard, elafleur_coveo, plavigueur, eaubin, lpblais-coveo, jpdery26, cricha |

## Links

- npm: https://www.npmjs.com/package/@coveops/context-dropdown
- npm.io page: https://npm.io/package/@coveops/context-dropdown

## Dependencies (3)

- [coveo-search-ui](https://npm.io/package/coveo-search-ui.md) ^2.10091.2
- [@coveops/turbo-core](https://npm.io/package/@coveops/turbo-core.md) ^1.2.1
- [@coveops/localization-manager](https://npm.io/package/@coveops/localization-manager.md) ^1.0.1

## Recent versions

- 1.0.1 (latest) — 2021-12-09
- 1.0.0 — 2021-12-09

## 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
```

2. Use the Component or extend it

Typescript:

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

Javascript

```javascript
const ContextDropdown = require('@coveops/context-dropdown').ContextDropdown;
```

3. You can also expose the component alongside other components being built in your project.

```javascript
export * from '@coveops/context-dropdown'
```

4. Or for quick testing, you can add the script from unpkg

```html
<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.

5. Include the component in your template as follows:

Place the component in your markup:

```html
<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:

```javascript
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`

---
_Source: https://npm.io/package/@coveops/context-dropdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._