Skip to content

Commit 5b51994

Browse files
docs(navigation): notes for navigation components behavior
1 parent a532841 commit 5b51994

File tree

5 files changed

+34
-0
lines changed

5 files changed

+34
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#navman-used
2+
* The `UrlField` has a default value (`Url`) and that will be used if present in the model even if you do not define it explicitly.
3+
4+
#end
5+
6+
#double-navigation
7+
* The component uses the `NavigationManager` from the framework to perform the navigation based on the value from the `UrlField`.
8+
9+
* If you have a template that adds anchors, or use a click event to navigate the user yourself, this may lead to double navigation and errors, especially if your model has a field called `Url`. To avoid such problems, either let the Telerik component do the navigation and remove the application-specific code that does it as well, or remove the URL setting (either rename the model field, or point the `UrlField` to a non-existing field).
10+
11+
#end

components/contextmenu/navigation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,11 @@ To use the Context Menu for navigating between pages:
8383
}
8484
````
8585

86+
## Notes
87+
88+
@[template](/_contentTemplates/common/navigation-components.md#navman-used)
89+
@[template](/_contentTemplates/common/navigation-components.md#double-navigation)
90+
8691
## See Also
8792

8893
* [Context Menu Overview]({%slug contextmenu-overview%})

components/drawer/navigation.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ To use the Drawer for navigating between pages:
5959
````
6060

6161

62+
## Notes
63+
64+
@[template](/_contentTemplates/common/navigation-components.md#navman-used)
65+
@[template](/_contentTemplates/common/navigation-components.md#double-navigation)
66+
67+
6268
## See Also
6369

6470
* [Drawer Overview]({% slug drawer-overview%})

components/menu/navigation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ To use the Menu for navigating between pages:
7979
}
8080
````
8181

82+
## Notes
83+
84+
@[template](/_contentTemplates/common/navigation-components.md#navman-used)
85+
@[template](/_contentTemplates/common/navigation-components.md#double-navigation)
86+
8287
## See Also
8388

8489
* [Menu Overview]({%slug components/menu/overview%})

components/treeview/navigation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,13 @@ To use the TreeView for navigating between pages:
121121
}
122122
````
123123

124+
125+
## Notes
126+
127+
@[template](/_contentTemplates/common/navigation-components.md#navman-used)
128+
@[template](/_contentTemplates/common/navigation-components.md#double-navigation)
129+
130+
124131
## See Also
125132

126133
* [TreeView Overview]({%slug components/treeview/overview%})

0 commit comments

Comments
 (0)