{"_id":"@coveops/taxonomy-breadcrumb","_rev":"48-2abf92b37ad002a59ea49e1d280bb5f8","name":"@coveops/taxonomy-breadcrumb","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@coveops/taxonomy-breadcrumb","version":"1.0.0","author":"","license":"Apache-2.0","_id":"@coveops/taxonomy-breadcrumb@1.0.0","maintainers":[{"name":"jfallaire","email":"jeanfrancois.allaire@gmail.com"},{"name":"davebouffard","email":"dbouffard@coveo.com"},{"name":"jmdro","email":"jmdrolet@coveo.com"},{"name":"eqcoveo","email":"equinn@coveo.com"},{"name":"jfleurent","email":"jfleurent@coveo.com"},{"name":"mthusscoveo","email":"mthuss@coveo.com"},{"name":"sfecteau","email":"sfecteau@coveo.com"},{"name":"jwolfe-coveo","email":"jwolfe@coveo.com"},{"name":"rvundavalli","email":"rvundavalli@coveo.com"},{"name":"gfoumbi","email":"gfoumbi@coveo.com"},{"name":"yass1408","email":"yassine_lakhdar@hotmail.com"},{"name":"coveoit","email":"itaccounts@coveo.com"}],"dist":{"shasum":"b71d5f8173f5c4f1b24938a99cb59597db2d64d0","tarball":"https://registry.npmjs.org/@coveops/taxonomy-breadcrumb/-/taxonomy-breadcrumb-1.0.0.tgz","fileCount":9,"integrity":"sha512-t8y8I8cWpEM7nrDcih0t0g/ZnMw3L8TRz3YCH+PXIjXmPMBbBIwxEC0X0EUczZj8ml/tDomtcHXyJTY3apfpiw==","signatures":[{"sig":"MEUCIBQTn+dXPN1jzbqtlZ/m5uiBexJ3aYc31Q+jX7sfslJOAiEAnJexFfWFMJ0CK7nqQXlz6kMtWn6+C8BTi3JQoxRY424=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":41018,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfMr/xCRA9TVsSAnZWagAAq48P/2jMbq06HWz2UI3fTonj\nX+x0EYQZirlDZGr6hxSlSZpG6qQjkp0qBUFaDxj2lmwNCT/VKc2y2iASfCjg\nsBG6WcBGNLkBS9vh6LMbcCDLcVezIjbvLd5Nf1J92qRd9NHKnJsK0p78CRvf\nXMxIH3ih3PPzaWAlOl+UjIlUPf0H2GY2b+Q2Iy+woMvOTYqAMAewNFqsNUIF\nO+OCSuHJ1CF6uX3QxcKOy7Ujq7ZpfTwPQHAdGIm9hPKo7m7OcV3SywUU6Q1e\nthiUEhCeYZXfqkqBMJQ5Tj/eBy4Cz8ksvVA06KdlUdo8Uzm66DgL5J7CbTOh\nVBrIaG4fAdACwiG3XnKxT4e3bj14ktgjF2iYs9LEbHz9pWq6sY9HqmcKigiE\nHj/ROTEFJW3JA5+3P16JSL5ZtBQuIBXUhNu6wKq+lFUMpOVhoBMhykdvHzOl\npxHDi+x0km+z53gzv9B3obVuFhhUWtd8kQ4Yj9QthmrJ5+ysgnXHNj+bH0u6\nN58mwKrfb/7Dxlfh8ZTfMned6gJgk7kN0gyuwp1PmjUkiJdUJVcCv57qIdDL\nKeGFCQLa5z29yOUXGesIsa82/21xbpwXV9sVQqnAD7nViGbJn2qlDoDn9u7T\nzkH58ICQYnhtW1ce4f1tRpt+T4iVKmzC34CoIW5zOIbvwh8Uj4dt3Ef2KuAg\nnZ94\r\n=57HF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"a84fe73493f152e3d8a8e2cfebc7a3919b12cbc8","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"coveops build TaxonomyBreadcrumb --template typescript","serve":"coveops serve","precompile":"npm run build"},"_npmUser":{"name":"jwolfe-coveo","email":"jwolfe@coveo.com"},"_npmVersion":"6.10.2","description":"Generates all permutations of breadcrumbs for specified field values, useful when needing to specify a hierarchy between those values.","directories":{},"_nodeVersion":"12.9.1","dependencies":{"coveo-search-ui":"^2.9373.8","@coveops/turbo-core":"^1.1.1"},"_hasShrinkwrap":false,"devDependencies":{"@coveops/cli":"^0.10.1"},"_npmOperationalInternal":{"tmp":"tmp/taxonomy-breadcrumb_1.0.0_1597161457212_0.10038731922548383","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@coveops/taxonomy-breadcrumb","version":"1.0.1","author":"","license":"Apache-2.0","_id":"@coveops/taxonomy-breadcrumb@1.0.1","maintainers":[{"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"}],"dist":{"shasum":"8cb85e864220464a5df1ee64c31c4b0d8329e031","tarball":"https://registry.npmjs.org/@coveops/taxonomy-breadcrumb/-/taxonomy-breadcrumb-1.0.1.tgz","fileCount":9,"integrity":"sha512-cK2wwCWUjT3kBZvGkor4ademmIn6deuqVuiEMYfGimKi+UE5WpMMkOCet8lFcl34Q9Uciphx4cLyTJOzPRfB9w==","signatures":[{"sig":"MEUCIQCn08Lf2cMBrF+wDYEjTUHafzH2C4zHmns6orLPm301TAIgXF5WdKn2q4LFQEoWf2vXpgLGMjtXqyygAwZIHEyu1AY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":43418,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhJ/gdCRA9TVsSAnZWagAAJNUP/2yMEUhcPE+p1A+ldPFv\nc9vfqhSXUCBIpabwje2+FeG42bC+3AXbQqeb9OPiv3QEiFVGmVTs6pAVw8Nt\njonAfvylSkvF/tD9lggQas2bXsJLOuBRiriCYPbO40x60lSF6xt9ylxOFLer\nM4F0BrlZm9vpJRmz+wuQqnWiymmwV6M0qlWQfZr0DVexCvnc+MvHnzDB29AE\nDjgx3ARqgcotomtQdxwOxSzR7czb0elAorC9WYynvlHFKvKyizPUMJANuaKX\nyJ739jseqYpeJ98OOhwWh6WYYzqQAwCE+iZ3zhvSQ8lEwHYwfETmvy97GiuW\nDWby6M6CDXD7W4IfHZiZ7Ul0uhGSDvnkcQnXA9Cz1RM+IrnzDCTljpgonqpA\nAo6zo9WOGPdjFg4N6WlFR4P0tqIqV+uhgN51gDEnZ1W9twdOJxYAgMn2YrGF\npGGif45NMC7W6S2i0VYqGyO5RQePJMG2bUnmrUZwuACmqTgQRvs6QCiIuzCc\nPBE0Z0ZHlw3aIIjtL/ZZIZZ7gm2K+FNDn23o1QQXBW10WDI3mA3SC6lOsEmC\nAPYJ/L+wwHMFk8B5rm1PiOOu/3kZ/HYPGMTpjdrs29a5achBqvRgqtRyaO6a\n+LUTbWP+OWYffTQfb1Cg9Lx3925ZcK3tBhmRXCwHJoBlgLDZRpH7/TIhoTvl\nG5kc\r\n=5P9H\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"3c93bd00cd3a6ffc0a2fa8810a5a05fcf75f711e","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"coveops build TaxonomyBreadcrumb --template typescript","serve":"coveops serve","precompile":"npm run build"},"_npmUser":{"name":"cricha","email":"cricha@coveo.com"},"_npmVersion":"6.14.11","description":"Generates all permutations of breadcrumbs for specified field values, useful when needing to specify a hierarchy between those values.","directories":{},"_nodeVersion":"14.16.0","dependencies":{"coveo-search-ui":"^2.10089.0","@coveops/turbo-core":"^1.2.1"},"_hasShrinkwrap":false,"devDependencies":{"@coveops/cli":"^0.17.0"},"_npmOperationalInternal":{"tmp":"tmp/taxonomy-breadcrumb_1.0.1_1630009373317_0.3912868802706748","host":"s3://npm-registry-packages"}}},"time":{"created":"2020-08-11T15:57:36.978Z","modified":"2026-05-13T17:46:32.915Z","1.0.0":"2020-08-11T15:57:37.308Z","1.0.1":"2021-08-26T20:22:53.484Z"},"license":"Apache-2.0","description":"Generates all permutations of breadcrumbs for specified field values, useful when needing to specify a hierarchy between those values.","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":"# TaxonomyBreadcrumb\n\nGenerates the appropriate permutation of breadcrumbs based on the specified field values, useful when needing to specify a hierarchy between those values.\n\nThis component is a result template component (see [Result Templates](https://docs.coveo.com/en/413/)).\n\nThis component handles both single and multi-value fields.\n\nFor example, using the following fields\n- @level1 = ['a', 'b']\n- @level2 = ['c', 'd']\n\nalong with the default separator will generate the following breadcrumbs based on the values of the specified fields:\n- a>c\n- a>d\n- b>c\n- b>d\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\n### Testing the Component\n\nFor quick testing, you can add the script from unpkg:\n\n```html\n<script src=\"https://unpkg.com/@coveops/taxonomy-breadcrumb@latest/dist/index.min.js\"></script>\n```\n\n> Disclaimer: Unpkg should be used for testing but not for production.\n\n### Using the Component\n\n1. Install the component into your project.\n\n    ```\n    npm i @coveops/taxonomy-breadcrumb\n    ```\n\n2. Use the Component or extend it:\n\n    Typescript\n\n    ```javascript\n    import { TaxonomyBreadcrumb, ITaxonomyBreadcrumbOptions } from '@coveops/taxonomy-breadcrumb';\n    ```\n\n    Javascript\n\n    ```javascript\n    const TaxonomyBreadcrumb = require('@coveops/taxonomy-breadcrumb').TaxonomyBreadcrumb;\n    ```\n\n3. You can also expose the component alongside other components being built in your project.\n\n    ```javascript\n    export * from '@coveops/taxonomy-breadcrumb'\n    ```\n\n4. Include the component in your template as follows:\n\n    Place the component in your markup:\n\n    ```html\n    <div class=\"CoveoTaxonomyBreadcrumb\" data-fields=\"@field1,@field2\"></div>\n    ```\n## Options\n\nThe following options can be configured:\n\n| Option | Required | Type | Default | Notes |\n| --- | --- | --- | --- | --- |\n| `fields` | Yes | IFieldOption[ ] | | The field(s) used to create the breadcrumb |\n| `separator` | No | string | `>` | The separator inserted between field values in the breadcrumb |\n| `label` | No | string | empty string | This label is inserted in front of the breadcrumb. Can be styled using the `.taxonomy-breadcrumb-label` CSS class. |\n\n## Extending\n\nExtending the component can be done as follows:\n\n```javascript\nimport { TaxonomyBreadcrumb, ITaxonomyBreadcrumbOptions } from \"@coveops/taxonomy-breadcrumb\";\n\nexport interface IExtendedTaxonomyBreadcrumbOptions extends ITaxonomyBreadcrumbOptions {}\n\nexport class ExtendedTaxonomyBreadcrumb extends TaxonomyBreadcrumb {}\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`\n","readmeFilename":"README.md"}