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/counted-tabs

v1.5.1

Published

A custom Coveo JSUI component to add result counts to tabs

Downloads

2,357

Readme

Counted Tabs

The Counted Tabs component appends to each tab its respective count of results and offers the option to hide tabs that have no content.

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

Testing the Component

For quick testing, you can add the script from unpkg:

<script src="https://unpkg.com/@coveops/counted-tabs@latest/dist/index.min.js"></script>

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

Using the Component

  1. Install the component into your project.

    npm i @coveops/counted-tabs
  2. Use the component or extend it:

    Typescript

    import { CountedTabs, ICountedTabsOptions } from '@coveops/counted-tabs';

    Javascript

    const CountedTabs = require('@coveops/counted-tabs').CountedTabs;
  3. You can also expose the component alongside other components being built in your project.

    export * from '@coveops/counted-tabs'
  4. Include the component in your template as follows:

    Place the component after the last tab in the coveo-tab-section.

    <div class="CoveoCountedTabs" data-field="@commontabs"></div>

Coveo Pipelines Configuration

In order for this component to work as expected, some changes will be necessary in your pipelines configuration on the Coveo Platform.

Fields

A commontabs field needs to be added as a Multi-Value Facet. For more information on adding a field, you can start with this reference: Adding and Managing Fields.

Sources

On each source displaying content in tabs, under manage mappings, add a semi-colon-separated list of all tab ids (as per your UI) that a given resource can see. For more information on mapping rules in Coveo, you can start with this reference: Adding and Managing Source Mappings.

In more complex situations, it may be necessary to add the commontabs field on a per-document basis, in which case a new post-conversion extension will be necessary. You can get started with your Extension Script with this documentation reference: Coveo Cloud V2 Indexing Pipeline Extensions.

Options

The following options can be configured:

| Option | Required | Type | Default | Notes | | --- | --- | --- | --- | --- | | field | Yes | string | | The custom field added to all sources to normalize the tabs | | defaultTab | No | string | All | The id of the default designated default CoveoTab | | hideWhenEmpty | No | boolean | true | Hides a tab when the count of its items is 0 | | countTemplate | No | string | ${count} | Applies basic formatting to the count value. For complex changes that require using html markup, see the formatCount method |

Extending

Extending the component can be done as follows:

import { CountedTabs, ICountedTabsOptions } from "@coveops/counted-tabs";

export interface IExtendedCountedTabsOptions extends ICountedTabsOptions {}

export class ExtendedCountedTabs extends CountedTabs {
    protected shouldHideTab(tab: HTMLElement, defaultTabNbRes: number): boolean {
        return shouldHide;
    }
}

The following methods can be extended to provide additional functionalities or handle more complex use cases.

shouldHideTab

protected shouldHideTab(tab: HTMLElement, defaultTabNbRes: number): boolean {}

The shouldHideTab method defines the logic used to hide the tab based on the id and counts.

formatCount

protected formatCount(count)

The formatCount method injects the count value for a given tab into the specified countTemplate. The value returned here will be shown as the count in the template.

getCountElement

protected getCountElement(nbRes): HTMLElement 

The getCountElement method returns the DOM element that will contain the formatted count.

Contribute

  1. Clone the project
  2. Build the code base: npm run build
  3. Update the test organization ID and API Token and configure your port on the npm serve script in the package.json: --org-id <ORG_ID> --token <ORG_KEY> --port 8080
  4. Serve the sandbox for live development npm run serve