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/commerce-components

v1.1.0

Published

Commerce Components Bundle

Downloads

17

Readme

CommerceComponents

Commerce Components Bundle

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.

Available Components

Dynamic Color Facet

Displays a dynamic facet where the check boxes are the color of their corresponding field value option. This component extends the DynamicFacet component, therefore all dynamic facet options can be used.

Dynamic Size Facet

Displays a dynamic facet where the field value options are organized numerically in a grid. This component extends the DynamicFacet component, therefore all dynamic facet options can be used.

Store Facet

Displays a facet that allows you to filter items based on availability in a particular store. The store options in the facet are ordered by distance from the end user. This component extends the Facet component, therefore all facet options can be used.

Store Picker

Displays a check box that allows you to filter results based on a single chosen store location.

Getting Started

Testing the Components

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

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

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

Using the Components

  1. Install the component bundle into your project.

    npm i @coveops/commerce-components
  2. Use the components or extend them:

    Typescript

    import { DynamicColorFacet } from '@coveops/commerce-components';
    import { DynamicSizeFacet } from '@coveops/commerce-components';
    import { StoreFacet } from '@coveops/commerce-components';
    import { StorePicker } from '@coveops/commerce-components';

    Javascript

    const DynamicColorFacet = require('@coveops/commerce-components').DynamicColorFacet;
    const DynamicSizeFacet = require('@coveops/commerce-components').DynamicSizeFacet;
    const StoreFacet = require('@coveops/commerce-components').StoreFacet;
    const StorePicker = require('@coveops/commerce-components').StorePicker;
  3. You can also expose the components alongside other components being built in your project.

    export * from '@coveops/commerce-components'
  4. Include the components in your template as follows:

    Place the component in your markup:

    <div class="CoveoDynamicColorFacet" data-field="@color"></div>
    
    <div class="CoveoDynamicSizeFacet" data-field="@productsize"></div>
    
    <div class="CoveoStoreFacet" data-title="Store" data-field="@storename" data-computed-field="@distance"
         data-computed-field-format="n2" data-sort-criteria="computedfieldascending" data-number-of-values-in-facet-search='8'
         data-enable-facet-search="true" data-enable-expand-collapse="true" data-auto-collapse="false"
         data-number-of-values="8" data-enable-settings="false"></div>
    
    <div class="CoveoStorePicker"></div>

Coveo Platform Configuration

In order for the Commerce Components to work as expected, you must have created an Omni-Channel Catalog in your organization. This requires you to have first indexed catalog content with the appropriate metadata.

Extending

Extending a component can be done as follows:

import { DynamicColorFacet, IDynamicColorFacetOptions } from "@coveops/commerce-components";

export interface IExtendedDynamicColorFacetOptions extends IDynamicColorFacetOptions {}

export class ExtendedDynamicColorFacet extends DynamicColorFacet {}

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