{"_id":"@coveops/dynamic-hierarchical-facet-breadcrumbs","_rev":"27-7c4c814ae0efd63441dbdbeea5571311","name":"@coveops/dynamic-hierarchical-facet-breadcrumbs","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@coveops/dynamic-hierarchical-facet-breadcrumbs","version":"1.0.0","keywords":[],"author":"","license":"Apache-2.0","_id":"@coveops/dynamic-hierarchical-facet-breadcrumbs@1.0.0","maintainers":[{"name":"dsisodraker","email":"dsisodraker@coveo.com"},{"name":"watallah","email":"watallah@coveo.com"},{"name":"coveoit","email":"itaccounts@coveo.com"},{"name":"gfoumbi","email":"gfoumbi@coveo.com"},{"name":"rvundavalli","email":"rvundavalli@coveo.com"},{"name":"jwolfe-coveo","email":"jwolfe@coveo.com"},{"name":"sfecteau","email":"sfecteau@coveo.com"},{"name":"mthusscoveo","email":"mthuss@coveo.com"},{"name":"jfleurent","email":"jfleurent@coveo.com"},{"name":"eqcoveo","email":"equinn@coveo.com"},{"name":"jmdro","email":"jmdrolet@coveo.com"},{"name":"davebouffard","email":"dbouffard@coveo.com"},{"name":"jfallaire","email":"jeanfrancois.allaire@gmail.com"},{"name":"achouan","email":"achouan@coveo.com"},{"name":"hsinghcoveo","email":"hsingh@coveo.com"},{"name":"wnijmeijer","email":"wnijmeijer@coveo.com"},{"name":"lgcarrierbedard","email":"lgcarrier@coveo.com"},{"name":"elafleur_coveo","email":"elafleur@coveo.com"},{"name":"plavigueur","email":"plavigueur@coveo.com"},{"name":"eaubin","email":"eaubin@coveo.com"},{"name":"lpblais-coveo","email":"lpblais@coveo.com"},{"name":"jpdery26","email":"jpdery@coveo.com"},{"name":"cricha","email":"cricha@coveo.com"}],"homepage":"https://github.com/Coveo-Turbo/dynamic-hierarchical-facet-breadcrumbs#readme","bugs":{"url":"https://github.com/Coveo-Turbo/dynamic-hierarchical-facet-breadcrumbs/issues"},"dist":{"shasum":"f70d6bf51e7c93c1e1db87907aa59316d9acbaf5","tarball":"https://registry.npmjs.org/@coveops/dynamic-hierarchical-facet-breadcrumbs/-/dynamic-hierarchical-facet-breadcrumbs-1.0.0.tgz","fileCount":9,"integrity":"sha512-mlrwvBb/HuDHOvIWdk66sPQEWdhDvBxEJU33WODSS47w7t79fnuU81m+xFKbOtyaGHkSiBLHho5vq5ozlaI+2w==","signatures":[{"sig":"MEUCIBBRQfvjpjajkVOI7nC0qlroavKwK1cOfNC/ZRVJiG1dAiEA665GKOuSxt3DAESqtsa6HSBCulaBoCKSO4iIma6jRuM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":43685,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJihDhgACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo7Fw//c3huq8yVeOJzAI3BuQYZsCeV/SXJ+gk3eTsA0TIsdO+qXvjs\r\nmU4aOop2N/1L0atS1RKEdOLMLV/huYABn4xax5WN5gPM80R7WOkKtcD/hG4t\r\nCoKpEBzCiKk6+/I98G/VY6h9bcJ24s691GcITRV9/jqHQ57vChjQkzCvKADk\r\nvSEnVjYwVtAeDExnoiT5NcMZ1jf07GobK89FeqDUhD8+W3O8ZB96gMF7tftn\r\nqVijhICrrZsUdjAga+MwxMbGG9SOZ59ZsG8q2ADqYdyNRZVaEdZLH09B13EG\r\nuTd9DqAgQ0PiWT4TF5ycLy3lU2F7PKdW7ZA9rCkWSAkXiyoB39iKpWKN8Mgu\r\n3feSs1yxiLok1mwXX207BvCHqiqGFHuceWBsJKIqDU0G6zYodwOKuLrgi3CX\r\ntEuvsD6gbBAdbyEBscyLN+XzBeDqxuFPKYKjg8NmXU1CN5ZLURrJNijuYPor\r\naonQlnu0tHn/ryXIkxx4PkNZdhj3ShC8ysIWKPTdYDKin8ZS5pbskB/Tzf68\r\nitU/B7GAVR9Fk9z/txQAFX0juMc+HVx5BM6zmZAKsKAsiPTchhe7dDeMq0uP\r\n7eL9YSf+4xAFYUO1L3JONQP//Cb0qi8zKpGg0vM6vDqgLgjcSgNxR8WQv4E/\r\n0ZrCUTZXUbfEI/Q+efY0nuZCBkZZbhtsEqc=\r\n=QOGD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"620e9cd871d1104609d857812c99d6fb0ba28aa3","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"coveops build DynamicHierarchicalFacetBreadcrumbs --template typescript","serve":"coveops serve","watch":"coveops build DynamicHierarchicalFacetBreadcrumbs --template typescript --watch","precompile":"npm run build"},"_npmUser":{"name":"cricha","email":"cricha@coveo.com"},"repository":{"url":"git+https://github.com/Coveo-Turbo/dynamic-hierarchical-facet-breadcrumbs.git","type":"git"},"_npmVersion":"6.14.11","description":"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.","directories":{},"_nodeVersion":"14.16.0","dependencies":{"coveo-search-ui":"^2.10095.3","@coveops/turbo-core":"^1.2.1","@coveops/localization-manager":"^1.0.1"},"_hasShrinkwrap":false,"devDependencies":{"@coveops/cli":"^0.17.0"},"_npmOperationalInternal":{"tmp":"tmp/dynamic-hierarchical-facet-breadcrumbs_1.0.0_1652832352392_0.5179906607400433","host":"s3://npm-registry-packages"}}},"time":{"created":"2022-05-18T00:05:52.337Z","modified":"2026-05-13T17:46:15.003Z","1.0.0":"2022-05-18T00:05:52.568Z"},"bugs":{"url":"https://github.com/Coveo-Turbo/dynamic-hierarchical-facet-breadcrumbs/issues"},"license":"Apache-2.0","homepage":"https://github.com/Coveo-Turbo/dynamic-hierarchical-facet-breadcrumbs#readme","keywords":[],"repository":{"url":"git+https://github.com/Coveo-Turbo/dynamic-hierarchical-facet-breadcrumbs.git","type":"git"},"description":"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.","maintainers":[{"email":"jfleurent@coveo.com","name":"jfleurent"},{"email":"jmdrolet@coveo.com","name":"jmdro"},{"email":"jeanfrancois.allaire@gmail.com","name":"jfallaire"},{"email":"achouan@coveo.com","name":"achouan"},{"email":"lpblais@coveo.com","name":"lpblais-coveo"},{"email":"watallah@coveo.com","name":"watallah"},{"email":"eshahneh@coveo.com","name":"ehsanshahneh"},{"email":"belbizri@coveo.com","name":"belbizri"},{"email":"jpurohit@coveo.com","name":"jpurohit_coveo"},{"email":"acherney2@coveo.com","name":"acherney2c"},{"email":"jcharron@coveo.com","name":"jcharron-coveo"},{"email":"oa-npmcoveops@oacvo.com","name":"oa-npmcoveops"}],"readme":"# DynamicHierarchicalFacetBreadcrumbs\n\nDisclaimer: This component was built by the community at large and is not an official Coveo JSUI Component. Use this component at your own risk.\n\n## Getting Started\n\n1. Install the component into your project.\n\n```\nnpm i @coveops/dynamic-hierarchical-facet-breadcrumbs\n```\n\n2. Use the Component or extend it\n\nTypescript:\n\n```javascript\nimport { DynamicHierarchicalFacetBreadcrumbs, IDynamicHierarchicalFacetBreadcrumbsOptions } from '@coveops/dynamic-hierarchical-facet-breadcrumbs';\n```\n\nJavascript\n\n```javascript\nconst DynamicHierarchicalFacetBreadcrumbs = require('@coveops/dynamic-hierarchical-facet-breadcrumbs').DynamicHierarchicalFacetBreadcrumbs;\n```\n\n3. You can also expose the component alongside other components being built in your project.\n\n```javascript\nexport * from '@coveops/dynamic-hierarchical-facet-breadcrumbs'\n```\n\n4. Or for quick testing, you can add the script from unpkg\n\n```html\n\n```\n\n> Disclaimer: Unpkg should be used for testing but not for production.\n\n5. Include the component in your template as follows:\n\nPlace the component in your markup:\n\n```html\n\n```\n\nwhere `@atlgeographicalhierarchy` is the name of the field you want to display as breadcrumbs. See more information in the `Options` section of the documentation.\n\n## Extending\n\nExtending the component can be done as follows:\n\n```javascript\nimport { DynamicHierarchicalFacetBreadcrumbs, IDynamicHierarchicalFacetBreadcrumbsOptions } from \"@coveops/dynamic-hierarchical-facet-breadcrumbs\";\n\nexport interface IExtendedDynamicHierarchicalFacetBreadcrumbsOptions extends IDynamicHierarchicalFacetBreadcrumbsOptions {}\n\nexport class ExtendedDynamicHierarchicalFacetBreadcrumbs extends DynamicHierarchicalFacetBreadcrumbs {}\n```\n\n## Options\n\nThe following options can be configured:\n\n| Option | Required | Type | Default | Notes |\n| --- | --- | --- | --- | --- |\n| `breadcrumbParentName` | No | string | `All Categories` | Name of the parent category. |\n| `field` | Yes | string | | Specifies the multi-value field whose values will be displayed as separate levels in the resulting breadcrumb. This must match the field used in your interface's `CoveoDynamicHierarchicalFacet`. It is important to note that this can only work with **one** instance of `CoveoDynamicHierarchicalFacet`. The `field` attribute **must match** the value of the one used in `CoveoDynamicHierarchicalFacet`. |\n\n\n## Contribute\n\n1. Clone the project\n2. 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.\n3. Build the code base: `npm run build`\n4. Serve the sandbox for live development `npm run serve`","readmeFilename":"README.md"}