{"id":26690772,"url":"https://github.com/svenanders/react-breadcrumbs","last_synced_at":"2025-03-26T16:01:05.845Z","repository":{"id":25825670,"uuid":"29264934","full_name":"robbestad/react-breadcrumbs","owner":"robbestad","description":"Automatic breadcrumbs for React-Router","archived":false,"fork":false,"pushed_at":"2023-01-04T18:43:45.000Z","size":2549,"stargazers_count":405,"open_issues_count":44,"forks_count":124,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-21T02:17:15.565Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robbestad.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-14T20:46:11.000Z","updated_at":"2025-02-11T15:47:54.000Z","dependencies_parsed_at":"2023-01-14T03:30:16.899Z","dependency_job_id":null,"html_url":"https://github.com/robbestad/react-breadcrumbs","commit_stats":null,"previous_names":["svenanders/react-breadcrumbs"],"tags_count":88,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robbestad%2Freact-breadcrumbs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robbestad%2Freact-breadcrumbs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robbestad%2Freact-breadcrumbs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robbestad%2Freact-breadcrumbs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robbestad","download_url":"https://codeload.github.com/robbestad/react-breadcrumbs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245689494,"owners_count":20656416,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-03-26T16:00:37.241Z","updated_at":"2025-03-26T16:01:05.838Z","avatar_url":"https://github.com/robbestad.png","language":"JavaScript","readme":"# React Breadcrumbs\n\n[React][1] component use to generate a breadcrumb trail (compatible with\n[React Router][2]).\n\n## Installation\n\n```sh\nnpm install --save react-breadcrumbs\n```\n\nNote: this version is only compatible with React-Router v4 and up. If you\nneed a version that is compatible with React-Router v3 and below, use\n```\nnpm install --save react-breadcrumbs@1.6.x\n```\n\n## Demo\n\nThe `/demo` directory provide one example of how this\npackage can be used. See the [`/demo`][3] for the code powering the small\nsite.\n\n## Usage\n\nThis package exposes two components, a `\u003cBreadcrumbs\u003e` component to wrap\nthe entire application and a `\u003cBreadcrumb\u003e` component to use throughout\nthe different sections (e.g. `\u003cRoute\u003e`s) within the application.\n\n### Breadcrumbs\n\nThe top-level `\u003cBreadcrumbs\u003e` component accepts the following `props`:\n\n- `className` (string): A class name for the outer wrapper element.\n- `hidden` (bool): Hide the inner breadcrumbs wrapper.\n- `setCrumbs` (func): A `function(crumbs: [Object]): [Object]` which will be called before crumbs are rendered.\n- `wrapper` (func|class): A react component to use for the inner wrapper.\n\n### Breadcrumb\n\n- `data` (object): An extended [location descriptor][5]. See below...\n- `hidden` (bool): Hide an individual breadcrumb (rarely needed).\n\nThe `data` object allows any valid [location descriptor][5] key (e.g.\n`pathname` or `search`) as well as a `title` prop:\n\n``` js\n{\n  title: 'Home', // Any valid `PropTypes.node`\n  pathname: '/',\n  // ... any other location descriptor values\n}\n```\n\nThe fact that the `title` can be any valid `PropTypes.node` allows for a huge\namount of customization. The following values are all valid:\n\n``` jsx\ntitle: 'Home'\ntitle: \u003cspan title=\"Hovered!\"\u003eHome\u003c/span\u003e\ntitle: \u003cCustomComponent title=\"Home\" icon=\"house\" /\u003e\n```\n\n### Authors\n\nThis project would not have been where it is today without massive contributions from\na whole lot of people ([`AUTHORS`][6]). Suport for React Router v4 support was written\nentirely by ([`@skipjack`][7]).\n\n[1]: https://facebook.github.io/react\n[2]: https://github.com/rackt/react-router\n[3]: https://github.com/svenanders/react-breadcrumbs/tree/master/demo\n[4]: http://breadcrumbs.surge.sh/index.html\n[5]: https://github.com/ReactTraining/react-router/blob/master/packages/react-router/docs/api/location.md\n[6]: https://github.com/svenanders/react-breadcrumbs/tree/master/AUTHORS\n[7]: https://github.com/skipjack\n","funding_links":[],"categories":["Uncategorized","Code Design"],"sub_categories":["Uncategorized","Router"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvenanders%2Freact-breadcrumbs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsvenanders%2Freact-breadcrumbs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvenanders%2Freact-breadcrumbs/lists"}