# @justeat/f-breadcrumbs

> Fozzie Bread Crumbs – Provides clickable paths back to previous pages

Latest version **4.4.0** (published 2024-03-14) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @justeat/f-breadcrumbs
pnpm add @justeat/f-breadcrumbs
yarn add @justeat/f-breadcrumbs
bun add @justeat/f-breadcrumbs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.4.0 |
| Published | 2024-03-14 |
| First published | 2021-02-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14 |
| Dependencies | 1 |
| Unpacked size | 136.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Maintainers | ilia.chikmarev, fidel.montesino, anastasiia.horban, raouf.sawehli, mmakwe-onyeka, gregory.palaci, arielfdr, dawidchar, roberto.santana, lizzie.turney, davidpn.11, dandel10n, mwh1989, kevinrodrigues, fozzie-bot, ashleynolan, simonsje, xander-marjoram, sergii.semenkiv, thomaswilliammcclean, benrwhite, robertellison, zlatin.ivanov, joshuang2332, oliversweb, andymayje, jamieomaguire, adammorr, lsphillips |
| Keywords | fozzie |

## Links

- npm: https://www.npmjs.com/package/@justeat/f-breadcrumbs
- Repository: https://github.com/justeat/fozzie-components
- Homepage: https://github.com/justeat/fozzie-components/tree/master/packages/components/molecules/f-breadcrumbs
- Issues: https://github.com/justeat/fozzie-components/issues
- npm.io page: https://npm.io/package/@justeat/f-breadcrumbs

## Dependencies (1)

- [@justeat/f-services](https://npm.io/package/@justeat/f-services.md) 1.x

## Recent versions

- 4.4.0 (latest) — 2024-03-14
- 4.3.0 — 2023-03-30
- 4.2.0 — 2022-07-25
- 4.1.0 — 2022-07-08
- 4.0.0 — 2022-06-20
- 3.2.2 — 2022-06-10
- 3.2.1 — 2022-03-18
- 3.2.0 — 2022-03-15
- 3.1.0 — 2021-10-27
- 3.0.0 — 2021-10-27
- 2.1.0 — 2021-10-21
- 2.0.0 — 2021-10-05
- 1.0.0 — 2021-09-17
- 0.3.0 — 2021-05-27
- 0.2.0 — 2021-02-05

## README

<div align="center">
  <h1>f-breadcrumbs</h1>

  <img width="125" alt="Fozzie Bear" src="../../bear.png" />

  <p>Provides clickable paths back to previous pages</p>
</div>

---

[![npm version](https://badge.fury.io/js/%40justeat%2Ff-breadcrumbsf-breadcrumbs.svg)](https://badge.fury.io/js/%40justeat%2Ff-breadcrumbs)
[![CircleCI](https://circleci.com/gh/justeat/fozzie-components.svg?style=svg)](https://circleci.com/gh/justeat/workflows/fozzie-components)
[![Coverage Status](https://coveralls.io/repos/github/justeat/f-breadcrumbs/badge.svg)](https://coveralls.io/github/justeat/f-breadcrumbs)
[![Known Vulnerabilities](https://snyk.io/test/github/justeat/f-breadcrumbs/badge.svg?targetFile=package.json)](https://snyk.io/test/github/justeat/f-breadcrumbs?targetFile=package.json)


## Usage

1.  Install the module using NPM or Yarn:

    ```bash
    yarn add @justeat/f-breadcrumbs
    ```

    ```bash
    npm install @justeat/f-breadcrumbs
    ```

2.  Import the component

    You can import it in your Vue SFC like this (please note that styles have to be imported separately):

    ```
    import BreadCrumbs from '@justeat/f-breadcrumbs';
    import '@justeat/f-breadcrumbs/dist/f-breadcrumbs.css';

    export default {
        components: {
            BreadCrumbs
        }
    }
    ```

    If you are using Webpack, you can import the component dynamically to separate the `bread-crumbs` bundle from the main `bundle.client.js`:

    ```
    import '@justeat/f-breadcrumbs/dist/f-breadcrumbs.css';

    export default {
        components: {
            ...
            BreadCrumbs: () => import(/* webpackChunkName: "bread-crumbs" */ '@justeat/f-breadcrumbs')
        }
    }

    ```
## Configuration

### Props

The props that can be defined are as follows:

| Prop  | Type  | Default | Description |
| ----- | ----- | ------- | ----------- |
| `links` | `Array - object` | - | Defines a list of links to be rendered by f-breadcrumbs |
| `hasBackground` | `Boolean` | false | Defines if the breadcrumbs component will have a background or not |

## Examples

The prop `Links`, from the above table follows the structure below, more examples can be found within the components test directory.

```
[{
    name: 'Link 1',
    url: '/link/1',
    routerLink: false
},
{
    name: 'Link 2',
    url: '',
    routerLink: false
}];
```

## Development
It is recommended to run the following commands at the root of the monorepo in order to install dependencies and allow you to view components in isolation via Storybook.

```bash
# cd ./fozzie-components
yarn install

## Testing
Unit / Integration / Contract

```bash
# Run Unit / Integration / Contract tests for all components
cd ./fozzie-components
yarn test
```

OR

```bash
# Run Unit / Integration / Contract tests for f-breadcrumbs
cd ./fozzie-components/packages/f-breadcrumbs
yarn test
```

Component Tests
```bash
# Run Component tests for all components
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components

yarn storybook:build
yarn storybook:serve-static
yarn test-component:chrome
```

OR

```bash
# Run Component tests for f-breadcrumbs
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components/packages/f-breadcrumbs
yarn test-component:chrome
```
## Documentation to be completed once module is in stable state.

---
_Source: https://npm.io/package/@justeat/f-breadcrumbs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
