open-index/open-npm huggingface dataset:
npm package: @jambon-baguette/add-to-cart
Description: @coveo/atomic component starter
Latest version: 0.0.3

# add-to-cart



<!-- Auto Generated Below -->


## Shadow Parts

| Part              | Description |
| ----------------- | ----------- |
| `"dropdown-menu"` |             |
| `"quantity"`      |             |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
npm package: @jambon-baguette/angular
Description: Coveo schematic for angular
Author: Coveo
Latest version: 1.28.12

# @coveo/angular

The `@coveo/angular` package contains the necessary components to set up a search page using [Coveo Headless](https://docs.coveo.com/headless) and [Angular Material](https://material.angular.io/) with the [Angular CLI](https://cli.angular.io/).

If you want to create a new Coveo Headless-powered search page with the Angular web framework from scratch, it is simpler to use the [`coveo ui:create:angular` command in the Coveo CLI](https://github.com/coveo/cli/blob/master/packages/cli/README.md#coveo-uicreateangular-name). The Coveo CLI will handle a lot of complexity for you. Calling the `@coveo/angular` package directly from the Angular CLI should rather be done to help you integrate a search page to an already existing Angular project.

## Installation

To add a Coveo Headless-powered search page using Material Angular to an existing Angular project, execute the following steps:

- Run `ng add @coveo/angular --org-id=<org-id> --api-key=<api-key>`, where you replace `<org-id>` by the unique identifier of your Coveo organization, and `<api-key>` by an API key granting the **impersonate** privilege in the target organization.
- Answer the questions prompted in your terminal to configure your interface styling.
- In your project, navigate to the new `server` folder. This is an [Express](https://www.npmjs.com/package/express) server which generates [Coveo search tokens](https://docs.coveo.com/en/1346/).
- The folder should contain a `.env.example` file. Create a copy of that file and rename it `.env`.
- In that new `.env` file, replace all placeholder variables (`<...>`) by the proper information for your organization. For more involved configurations, you can modify the request parameters used in the `middlewares/searchToken.ts` file.
- You can now go back to the root directory of your project and serve it by running `ng serve`.

## Contributing

### Component schematics

TODO

### Development

TODO

### Testing

To test the schematic locally, install `@angular-devkit/schematics-cli` globally and use the `schematics` command-line tool. That tool mimics `generate` and `add` commands of the Angular CLI.

Check the documentation with

```bash
schematics --help
```

First of all, create a new project:

```
ng new my-test-app --routing --style css
```

Make sure to link your local schematic to the project you want to use it in.

```
cd my-test-app
npm link /path/to/coveo-cli/packages/angular
```

> You can also use `npm pack` in your schematics project, then `npm install /path/to/artifact.tar.gz` in your Angular project.
> This mimics `npm install` more than npm link.

Run your schematic

```
schematics @coveo/angular:headless-engine --org-id<org-id> --api-key=<api-key> --dry-run
```

### Unit Testing

`npm run test` will run the unit tests, using Jasmine as a runner and test framework.

### Publishing

To publish, simply do:

```bash
npm run build
npm publish
```

That's it!
npm package: @jambon-baguette/counted-tab
Description: @coveo/atomic component starter
Latest version: 0.0.3

# counted-tab



<!-- Auto Generated Below -->


## Overview

custom Atomic counted tab component, initializing itself against a parent search interface in order to retrieve the bindings.

 usage <counted-tab field="<fieldname>" value="<field value for the filtering> label="<string label that should appear>" initial-state="<true or false to select a default tab value>" tab-id=<"unique tab id"> ></counted-tab>

 example <counted-tab field="source" value="Salesforce" label="Salesforce Content" initial-state="true" tab-id="SF"></counted-tab>

 NB: The field used for this tab will required to be added as a groupBy in the engine.

## Properties

| Property             | Attribute       | Description | Type     | Default     |
| -------------------- | --------------- | ----------- | -------- | ----------- |
| `field` _(required)_ | `field`         |             | `string` | `undefined` |
| `initialState`       | `initial-state` |             | `string` | `"false"`   |
| `label` _(required)_ | `label`         |             | `string` | `undefined` |
| `tabId` _(required)_ | `tab-id`        |             | `string` | `undefined` |
| `value` _(required)_ | `value`         |             | `string` | `undefined` |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
npm package: @jambon-baguette/cra-template
Description: Coveo template for Create React App.
Latest version: 1.28.12

# @coveo/cra-template

This is the Coveo template for [Create React App](https://github.com/facebook/create-react-app).

To use this template, add `--template @coveo/cra-template` when creating a new app.

For example:

```sh
npx create-react-app my-app --template @coveo/cra-template

# or

yarn create react-app my-app --template @coveo/cra-template
```

For more information, please refer to:

- [Getting Started](https://create-react-app.dev/docs/getting-started) – How to create a new app.
- [User Guide](https://create-react-app.dev) – How to develop apps bootstrapped with Create React App.
npm package: @jambon-baguette/create-atomic
Description: Coveo Atomic Generator
Author: Coveo
Latest version: 1.28.12

# @coveo/create-atomic

The `@coveo/create-atomic` package contains the necessary components to set up a search page using [Coveo Atomic](https://docs.coveo.com/atomic), which is built upon [Coveo Headless](https://docs.coveo.com/headless).

If you want to create a new Coveo Headless-powered search page with the Coveo Atomic web framework from scratch, it is simpler to use the [`coveo ui:create:atomic` command in the Coveo CLI](../cli/README.md#coveo-uicreateatomic-name). The Coveo CLI will handle a lot of complexity for you.

## Installation

We recommend using the [`coveo ui:create:atomic` command in the Coveo CLI](../cli/README.md#coveo-uicreateatomic-name), but to use the project directly, you can also run:

```
npm init @coveo/atomic myapp
```

or

```
npx @coveo/create-atomic myapp
```

or

```
npm install -g @coveo/create-atomic
create-atomic myapp
```

If you run the project directly, you will be prompted to fill out your organization's authentication information.
npm package: @jambon-baguette/custom-per-page
Description: @coveo/atomic component starter
Latest version: 0.0.3

# custom-per-page



<!-- Auto Generated Below -->


## Properties

| Property           | Attribute           | Description | Type     | Default          |
| ------------------ | ------------------- | ----------- | -------- | ---------------- |
| `choicesDisplayed` | `choices-displayed` |             | `string` | `"10,25,50,100"` |
| `initialChoice`    | `initial-choice`    |             | `number` | `undefined`      |


## Shadow Parts

| Part                 | Description |
| -------------------- | ----------- |
| `"label"`            |             |
| `"select"`           |             |
| `"select-separator"` |             |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
npm package: @jambon-baguette/export-search-results
Latest version: 0.0.3

# export-search-results



<!-- Auto Generated Below -->


## Overview

This component adds an icon with a tooltip that when pressed it will try to download the search results on the page into a CSV file.
The idea is that this component is placed inside `<atomic-layout-section section="status">`.
For that, there is a `grid-area` CSS prop defined, and the index.css should be updated to include this grid area in the mentioned parent.
However, this component might be placed anywhere after a proper CSS adjustment.

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
npm package: @jambon-baguette/results-manager
Description: @coveo/atomic component starter
Latest version: 0.0.3

# results-manager



<!-- Auto Generated Below -->


## Overview

Component used to manage results & result templates.
See https://docs.coveo.com/en/atomic/latest/usage/create-a-result-list/

## Methods

### `changeLayout(type: ResultDisplayLayout) => Promise<void>`

Switch result list layout from list, grid and table

#### Returns

Type: `Promise<void>`




----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
npm package: @jambon-baguette/save-query
Description: @coveo/atomic component starter
Latest version: 0.0.5

# save-query

It renders a button that is supposed to be placed inside `<atomic-layout-section section="status">` (although it can go anywhere). Once the button is clicked, there is a little window displayed that contains saved queries and lets the user save a new one, or filter amongst the already listed ones.

The queries are saved in the browser's local storage. Once a saved query is clicked onto, the URL will be updated with the one saved for the query.

<img width="795" alt="image" src="https://user-images.githubusercontent.com/38492301/206161791-2d84708c-8e8d-4c49-bb5a-eaae4ed9b634.png">

<img width="792" alt="image" src="https://user-images.githubusercontent.com/38492301/206161837-f25bcaac-be2c-4660-bd9e-a9333c4d04ff.png">



<!-- Auto Generated Below -->


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
npm package: @jambon-baguette/search-box-category-suggestions
Latest version: 0.0.3

# search-box-category-suggestions



<!-- Auto Generated Below -->


## Overview

The `search-box-category-suggestions` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of category suggestions.

## Shadow Parts

| Part                   | Description                                         |
| ---------------------- | --------------------------------------------------- |
| `"recent-query-clear"` | The 'Clear' button for clearing recent queries    . |
| `"recent-query-title"` | The 'Recent queries' title.                         |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
npm package: @jambon-baguette/search-token-lambda
Description: An [Netlify Function](https://functions.netlify.com/) to generate [Coveo search tokens](https://docs.coveo.com/en/1346/).
Author: Coveo
Latest version: 1.28.12

# Simple search token generation lamba function

An [Netlify Function](https://functions.netlify.com/) to generate [Coveo search tokens](https://docs.coveo.com/en/1346/).

## Setup environment

Create the `.env` file at the root of this project using the `.env.example` file as starting point. Make sure to replace all placeholder variables (`<...>`) by the proper information for your organization.
For more involved configurations, you can modify the request parameters used in the `functions/token/generateToken.ts` file.

## Installation

```bash
npm install
```

## Usage

```bash
npm start
```

This will start a server listening on port 9999. The app will return a [Coveo search token](https://docs.coveo.com/en/1346/) when you make a GET request to the [/.netlify/functions/token](http://localhost:9999/.netlify/functions/token) path. Every other path will respond with a **404 Not Found** error.

## Documentation

### Search Token Authentication

A search token is a special JSON web token typically used to temporarily grant the privilege to execute queries as a specific user and log usage analytics events.
To understand search tokens and how they work in more detail, visit the [Search Token Authentication](https://docs.coveo.com/en/56/build-a-search-ui/search-token-authentication) page.
npm package: @jambon-baguette/search-token-server
Description: An [Express](https://www.npmjs.com/package/express) server to generate [Coveo search tokens](https://docs.coveo.com/en/1346/).
Latest version: 1.28.12

# Simple search token generation server

An [Express](https://www.npmjs.com/package/express) server to generate [Coveo search tokens](https://docs.coveo.com/en/1346/).

## Setup environment

Create the `.env` file at the root of this project using `.env.example` as starting point and make sure to replace all placeholder variables `<...>` by the proper information for your organization.
For more involved configurations, you can modify the request parameters used in the `middlewares/searchToken.ts` file.

## Installation

```bash
npm install
```

## Usage

```bash
npm start
```

This will start a server listening on port 3000. The app will return a [Coveo search token](https://docs.coveo.com/en/1346/) when you make a GET request to the [/token](http://localhost:3000/token) path. Every other path will respond by a **404 Not Found** error.

## Documentation

### Search Token Authentication

A search token is a special JSON web token typically used to temporarily grant the privilege to execute queries as a specific user and log usage analytics events.
To understand search tokens and how they work in more detail, visit the [Search Token Authentication](https://docs.coveo.com/en/56/build-a-search-ui/search-token-authentication) page.
npm package: @jambon-baguette/static-filter
Latest version: 0.0.3

# static-filter



<!-- Auto Generated Below -->


## Properties

| Property           | Attribute            | Description | Type     | Default |
| ------------------ | -------------------- | ----------- | -------- | ------- |
| `caption`          | `caption`            |             | `string` | `""`    |
| `expression`       | `expression`         |             | `string` | `""`    |
| `userCoveoField`   | `user-coveo-field`   |             | `string` | `""`    |
| `userSessionField` | `user-session-field` |             | `string` | `""`    |


## Shadow Parts

| Part         | Description |
| ------------ | ----------- |
| `"checkbox"` |             |
| `"label"`    |             |
| `"slider"`   |             |
| `"switch"`   |             |
| `"wrapper"`  |             |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
npm package: @jambon-baguette/vue-cli-plugin-typescript
Description: Vue-cli 3 plugin for adding Coveo Headless support
Latest version: 1.28.12

# @coveo/vue-cli-plugin-typescript

The `@coveo/vue-cli-plugin-typescript` package contains the necessary components to set up a search page using [Coveo Headless](https://docs.coveo.com/headless) and [Buefy](https://buefy.org/) with the [Vue CLI](https://cli.vuejs.org/).

If you want to create a new Coveo Headless-powered search page with the Vue.js web framework from scratch, it is simpler to use the [`coveo ui:create:vue` command in the Coveo CLI](https://github.com/coveo/cli/tree/master/packages/cli#coveo-uicreatevue-name). The Coveo CLI will handle a lot of complexity for you. Calling the `@coveo/vue-cli-plugin-typescript` package directly from the Angular CLI should rather be done to help you integrate a search page to an already existing Vue.js project.

## Installation

To add a Coveo Headless-powered search page using Buefy to an existing TypeScript Vue.js project, execute the following steps:

- Run `vue add @coveo/vue-cli-plugin-typescript`.
- The root folder should contain a `.env` file. Replace all placeholder variables (`<...>`) by the proper information for your organization. Consult the example configuration file named `.env.example` as needed. For more involved configurations, you can modify the request parameters used in the `server/middlewares/searchToken.ts` file.
- Run `npm start`.

## Contributing

### Compiles and hot-reloads for development

```
npm start
```

### Compiles and minifies for production

```
npm run build
```

### Lints and fixes files

```
npm run lint
```

### Customize configuration

See [Configuration Reference](https://cli.vuejs.org/config/).