{"id":39486322,"url":"https://github.com/vtex-apps/breadcrumb","last_synced_at":"2026-03-02T17:13:10.034Z","repository":{"id":13554510,"uuid":"74605887","full_name":"vtex-apps/breadcrumb","owner":"vtex-apps","description":"Breadcrumb App","archived":false,"fork":false,"pushed_at":"2025-04-09T20:38:17.000Z","size":473,"stargazers_count":0,"open_issues_count":3,"forks_count":11,"subscribers_count":45,"default_branch":"master","last_synced_at":"2026-01-18T15:01:20.048Z","etag":null,"topics":["hacktoberfest","srv-store-framework","store-framework","vtex-io","xp-developer"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vtex-apps.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-23T19:03:10.000Z","updated_at":"2025-04-09T20:38:20.000Z","dependencies_parsed_at":"2024-08-20T15:32:40.896Z","dependency_job_id":"f9e7d503-947e-49c3-9db2-32f167e3f552","html_url":"https://github.com/vtex-apps/breadcrumb","commit_stats":null,"previous_names":[],"tags_count":54,"template":false,"template_full_name":null,"purl":"pkg:github/vtex-apps/breadcrumb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fbreadcrumb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fbreadcrumb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fbreadcrumb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fbreadcrumb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex-apps","download_url":"https://codeload.github.com/vtex-apps/breadcrumb/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex-apps%2Fbreadcrumb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28607624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T16:10:39.856Z","status":"ssl_error","status_checked_at":"2026-01-20T16:10:39.493Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","srv-store-framework","store-framework","vtex-io","xp-developer"],"created_at":"2026-01-18T05:26:17.063Z","updated_at":"2026-01-20T17:09:13.720Z","avatar_url":"https://github.com/vtex-apps.png","language":"TypeScript","readme":"📢 Use this project, [contribute](https://github.com/vtex-apps/breadcrumb) to it or open issues to help evolve it using [Store Discussion](https://github.com/vtex-apps/store-discussion).\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n# Breadcrumb\n\nThe VTEX BreadCrumb is a navigation scheme that shows a user's browsing history up to their current location in your store.\n\n![img2-breadcrumb](https://user-images.githubusercontent.com/52087100/69836587-a4237380-1228-11ea-89c8-0f34cea3a96f.png)\n\n## Configuration\n\n1. Import the breadcrumb's app to your theme's dependencies in the `manifest.json`, for example:\n\n```json\n  dependencies: {\n    \"vtex.breadcrumb\": \"1.x\"\n  }\n```\n\n2. Add the `breadcrumb` block to the Product template. For example:\n\n```\n \"breadcrumb\": {\n    \"props\": {\n      \"showOnMobile\": true\n    }\n  },\n```\n\n| Prop name    | Type            | Description    | Default value                                                                                                                               |\n| ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | \n| `showOnMobile`        | `Boolean`       | It determines whether Breadcrumb should also be displayed on mobile          | `false`              |\n| `homeIconSize`  | `Number`        | Controls the `size` property of [`IconHome`](https://github.com/vtex-apps/store-icons#icons)                                                                                                      | `26` |\n| `caretIconSize` | `Number`        | Controls the `size` property of [`IconCaret`](https://github.com/vtex-apps/store-icons#icons)                                                                                                     | `8` |\n\n:warning: The product's categories should appear as an array in one of this two formats:\n\n```javascript\ncategories = ['/Eletronics/', '/Eletronics/Computers']\n```\n\n```javascript\ncategories = ['eletronics', 'eletronics-computers']\n```\n\n3. Add the `breadcrumb.search` block to the Search template. For example:\n\n```\n \"breadcrumb.search\": {\n    \"props\": {\n      \"showOnMobile\": true\n    }\n  },\n```\n\n| Prop name    | Type            | Description    | Default value                                                                                                                               |\n| ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | \n| `showOnMobile`        | `Boolean`       | It determines whether Breadcrumb should also be displayed on mobile          | `false`              |\n| `homeIconSize`  | `Number`        | Controls the `size` property of [`IconHome`](https://github.com/vtex-apps/store-icons#icons)                                                                                                      | `26` |\n| `caretIconSize` | `Number`        | Controls the `size` property of [`IconCaret`](https://github.com/vtex-apps/store-icons#icons)                                                                                                     | `8` |\n\u003e ℹ️ *The `breadcrumb.search` block is specific for the Breadcrumb inside the search result page.* \n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization). \n\n| CSS Handles |\n| ----------- | \n| `container` | \n| `link`      | \n| `arrow`     | \n| `homeLink`  | \n| `termArrow` |\n\n\n## Contributors ✨\n\nThanks goes to these wonderful people:\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex-apps%2Fbreadcrumb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex-apps%2Fbreadcrumb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex-apps%2Fbreadcrumb/lists"}