Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ianrothmann authored Mar 26, 2018
1 parent 7f970bb commit dfc6b50
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,32 @@ This package integrates with VueBridge and makes the menu available in `$store.s
<rocket-framework-menu :menu="$store.state.server.rocketMenus&&$store.state.server.rocketMenus.main"></rocket-framework-menu>
```

### Breadcrumbs

Use `Rocket::breadcrumbs()`, to access the BreadcrumbsService:

You may either use:
```php
@include('rocket::breadcrumbsmenu')
```
to show a menu icon with the items in a menu

or
```php
@include('rocket::breadcrumbs')
```
To display a classic breadcrumbs bar. Everything is only implemented in Vuetify. You cannot use both, be sure to only use one of them on a page.

in `config/rocketframework.php`, you may set
```php
'breadcrumbs' => [
'number'=>4, //Number of breadcrumbs to save
'default'=>'show' //Default behaviour to show or hide breadcrumbs
]
```

On any page you may call: `Rocket::breadcrumbs()->show()` or `Rocket::breadcrumbs()->hide()` to bread away from the default behaviour. You can also set a namespace for the breadcrumbs to limit them on certain parts/sessions on the system. For instance: `Rocket::breadcrumbs()->setBreadcrumbsNamespace($clientid)`

## Edit in place language
This enables you to use blade syntax `@editabletext(language_line_code)` or `@editablehtml(language_line_code)`. If edit mode is active, a user will be able to edit the text in place. This is useful for public facing websites etc.

Expand Down

0 comments on commit dfc6b50

Please sign in to comment.