Skip to content

Commit f9523ba

Browse files
committed
chore(drawer): added readme file
1 parent ae3c66e commit f9523ba

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

drawer/template/template/readme.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Drawer as Side Navigation
2+
3+
This sample project shows one way to use the [Telerik Drawer](https://demos.telerik.com/blazor-ui/drawer/overview) as a side navigation in your project.
4+
5+
Key points of interest:
6+
7+
* The Drawers [Template](https://docs.telerik.com/blazor-ui/components/drawer/templates#template) is used in order to control the rendering of the entire component.
8+
9+
* All the logic, styles and code related to the drawer are in the `~/Shared/MainLayout.razor` file. You should separate them according to your project structure and best practices.
10+
11+
* Code comments in the file provide details.
12+
13+
* CSS rules define the size of the various containers and scrolling:
14+
* The drawer will take up the entire viewport.
15+
* Scrolling happens in the content area of the drawer only.
16+
* The sticky header stays above the content.
17+
18+
* The current page is denoted by the selected item in the drawer:
19+
* On initial load it is taken from the Data collection with the help of the `NavigationManager`.
20+
* On SPA navigation, the navigation happens in the `@Body` so the click selects the item and it does not dispose
21+
22+
* In this sample, the list of links is hardcoded for brevity. You can populate it later based on user roles and privileges or any other applicable business logic.

0 commit comments

Comments
 (0)