Back to plugins & integrations

Product Primary Collection icon

Product Primary Collection

Set a primary collection for your products, so you can create the correct breadcrumbs in your storefront

npm install @pinelab/vendure-plugin-primary-collection

Integration type

Partner
Plugins built by certified Vendure partners

Category

Other

Last published

28 days ago

Downloads in past month

272
README.md

Vendure Primary Collection Plugin

Official documentation here

To construct breadcrumbs and URL’s it’s useful to have a primary collection for each product, in case a product is part of multiple collections. This plugin extends Vendure’s Product graphql type, adding a primaryCollection field that points to the primary collection of a product.

Primary collections can be selected in the Admin UI’s product detail view.

This Plugin also exports PrimaryCollectionHelperService which can be used to assign primaryCollection’s to products without existing values by running PrimaryCollectionHelperService.setPrimaryCollectionForAllProducts.

Getting started

Add the plugin to your vendure-config.ts:

plugins: [
  PrimaryCollectionPlugin.init({
    customFieldUITabName: 'Primary Collection',
  }),
  AdminUiPlugin.init({
    port: 3002,
    route: 'admin',
    app: compileUiExtensions({
      outputPath: path.join(__dirname, '__admin-ui'),
      extensions: [PrimaryCollectionPlugin.ui],
    }),
  }),
];

And your good to go with just that.