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/recent-queries

v1.1.2

Published

A component showing recent queries performed by the user

Downloads

30

Readme

Recent Queries

Records user queries and displays it in the UI. The component supports two modes: omnibox mode or standalone mode.

The omnibox mode will append the recent queries under the query suggestions. The standalone mode will display the recent queries under the <div class="CoveoRecentQueries"> HTML tag.

Getting Started

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

Typescript:

import { RecentQueries, IRecentQueriesOptions } from '@coveops/recent-queries';

Javascript

const RecentQueries = require('@coveops/recent-queries').RecentQueries;
  1. You can also expose the component alongside other components being built in your project.
export * from '@coveops/recent-queries'
  1. Or for quick testing, you can add the script from unpkg
<script src="https://unpkg.com/@coveops/recent-queries@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:

Omnibox mode:

Place the component after the CoveoSearchBox HTML tag

    <div class="CoveoSearchbox" data-enable-omnibox="true"></div>
    <div class="CoveoRecentQueries" data-show-in-query-suggest="true"></div>

Standalone mode:

It is still recommended to place the component after the CoveoSearchBox HTML tag, but can be placed anywhere within the CoveoSearchInterface

    <div class="CoveoSearchbox" data-enable-omnibox="true"></div>
    <div class="CoveoRecentQueries" data-show-in-query-suggest="false"></div>

Extending

Extending the component can be done as follows:

import { RecentQueries, IRecentQueriesOptions } from '@coveops/recent-queries';

export interface IExtendedRecentQueriesOptions extends IRecentQueriesOptions {}

export class ExtendedRecentQueries extends RecentQueries {}

Options

The following options can be configured:

| Option | Required | Type | Default | Notes | | -------------------- | -------- | ------- | ---------------- | ---------------------------------------------------------------------- | | caption | No | string | Recent Queries | The caption shown above the recent queries in Standalone mode | | numberOfQueries | No | number | 5 | Specifies the number of queries to record in storage and display | | isStandalone | No | boolean | false | Specifies whether the searchbox is a standalone | | useCookies | No | boolean | false | Specifies whether to use cookies or the localStorage | | showInQuerySuggest | No | boolean | true | Specifies which mode to use: true for Omnibox, false for Standalone |

Support

The Recent Queries supports the follow locale string ids:

Recent Queries - Label to show above the recent queries in Omnibox mode

Suggested Search Results - Label to show above the query suggest in Omnibox mode

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