Skip to content
This repository has been archived by the owner on Mar 20, 2022. It is now read-only.

Commit

Permalink
Merge pull request #37 from hotmeteor/readme-breadcrumbs
Browse files Browse the repository at this point in the history
Add Breadcrumbs docs to the readme
  • Loading branch information
edalzell authored Apr 15, 2021
2 parents 54ee78b + 1546080 commit a21da6f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,22 @@ The package will automatically register itself.

## Usage

### Breadcrumbs

```blade
@breadcrumbs
$item['url']
@endbreadcrumbs
```

You can use the [same parameters](https://statamic.dev/tags/nav-breadcrumbs#parameters) as the `nav:breadcrumbs` tag.

```blade
@breadcrumbs(['include_home' => false, 'reverse' => true])
$item['url']
@endbreadcrumbs
```

### Collection

Use the same params as the `{{ collection }}` tag
Expand Down

0 comments on commit a21da6f

Please sign in to comment.