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/taxonomy-breadcrumb

v1.0.1

Published

Generates all permutations of breadcrumbs for specified field values, useful when needing to specify a hierarchy between those values.

Downloads

18

Readme

TaxonomyBreadcrumb

Generates the appropriate permutation of breadcrumbs based on the specified field values, useful when needing to specify a hierarchy between those values.

This component is a result template component (see Result Templates).

This component handles both single and multi-value fields.

For example, using the following fields

  • @level1 = ['a', 'b']
  • @level2 = ['c', 'd']

along with the default separator will generate the following breadcrumbs based on the values of the specified fields:

  • a>c
  • a>d
  • b>c
  • b>d

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/taxonomy-breadcrumb@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/taxonomy-breadcrumb
  2. Use the Component or extend it:

    Typescript

    import { TaxonomyBreadcrumb, ITaxonomyBreadcrumbOptions } from '@coveops/taxonomy-breadcrumb';

    Javascript

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

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

    Place the component in your markup:

    <div class="CoveoTaxonomyBreadcrumb" data-fields="@field1,@field2"></div>

Options

The following options can be configured:

| Option | Required | Type | Default | Notes | | --- | --- | --- | --- | --- | | fields | Yes | IFieldOption[ ] | | The field(s) used to create the breadcrumb | | separator | No | string | > | The separator inserted between field values in the breadcrumb | | label | No | string | empty string | This label is inserted in front of the breadcrumb. Can be styled using the .taxonomy-breadcrumb-label CSS class. |

Extending

Extending the component can be done as follows:

import { TaxonomyBreadcrumb, ITaxonomyBreadcrumbOptions } from "@coveops/taxonomy-breadcrumb";

export interface IExtendedTaxonomyBreadcrumbOptions extends ITaxonomyBreadcrumbOptions {}

export class ExtendedTaxonomyBreadcrumb extends TaxonomyBreadcrumb {}

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