Skip to content

Commit

Permalink
[Doc] Update doc on navigation links to reflect implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
andrerom committed Aug 30, 2017
1 parent 10a08aa commit fa1f6b3
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/howto/add_navigation_hub_items.md
Expand Up @@ -62,7 +62,7 @@ services:
- '@router'
- "Blog"
- "content"
- 123
- {locationId: 123}
tags:
- {name: ezplatform.ui.link}
public: false
Expand All @@ -73,7 +73,7 @@ services:
|`router`|The router service (`@router`)|
|`name`|The human readable name of the link, as displayed in the UI|
|`zoneIdentifier`|The zone this links should be visible for. In the example above, the link is visible inside the "content" zone|
|`location`|The parameters used to load the Location. The key indicates the parameter. Possible keys: `locationId`|
|`route_parameters`|The parameters used to load the Location. The key indicates the parameter. Possible keys: `locationId`|

### Route links
A route link will link to any defined route, with any given set of parameters.
Expand All @@ -95,7 +95,6 @@ services:
- "Sections"
- "admin"
calls:
# @todo implement the setter ;)
- [setRoutePrefix, ["admin_section"]]
tags:
- {name: ezplatform.ui.link}
Expand All @@ -105,9 +104,9 @@ services:
|Argument|Description|
|--------|-----------|
|`router`|The router service (`@router`)|
|`route_name`|The Symfony route name used to generate the link and match requests|
|`name`|The human readable name of the link, as displayed in the UI|
|`zoneIdentifier`|The zone this links should be visible for. In the example above, the link is visible inside the "admin" zone|
|`route_name`|The route used to generate the link and match requests|
|`route_parameters`|An array of route parameters that will be used to generate the link and match requests|

A setter method `setRoutePrefix` can be used to define a route prefix used to match requests.
Expand Down

0 comments on commit fa1f6b3

Please sign in to comment.