Skip to content

Commit f7d449a

Browse files
author
Kendo Bot
committed
Sync with Kendo UI Professional
1 parent 2ae9e22 commit f7d449a

File tree

19 files changed

+542
-162
lines changed

19 files changed

+542
-162
lines changed

docs-aspnet/_config-mvc.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,12 @@ defaults:
395395
values:
396396
title_prefix: "MVC ScrollView Component"
397397
-
398+
scope:
399+
path: "html-helpers/navigation/appbar"
400+
values:
401+
title_prefix: "MVC AppBar Component"
402+
title: "AppBar"
403+
398404
scope:
399405
path: "html-helpers/navigation/breadcrumb"
400406
values:

docs-aspnet/_config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,8 @@ navigation:
347347
title: "Layout"
348348
"html-helpers/navigation":
349349
title: "Navigation"
350+
"html-helpers/navigation/appbar":
351+
title: "Appbar"
350352
"html-helpers/navigation/breadcrumb":
351353
title: "Breadcrumb"
352354
"html-helpers/navigation/stepper":
@@ -899,6 +901,11 @@ defaults:
899901
values:
900902
title_prefix: "Core ScrollView Component"
901903
-
904+
scope:
905+
path: "html-helpers/navigation/appbar"
906+
values:
907+
title_prefix: "Core AppBar Component"
908+
902909
scope:
903910
path: "html-helpers/navigation/breadcrumb"
904911
values:
@@ -1269,6 +1276,11 @@ defaults:
12691276
values:
12701277
title_prefix: "Core ScrollView Component"
12711278
-
1279+
scope:
1280+
path: "tag-helpers/navigation/appbar"
1281+
values:
1282+
title_prefix: "Core AppBar Component"
1283+
12721284
scope:
12731285
path: "tag-helpers/navigation/breadcrumb"
12741286
values:
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Items
3+
page_title: Items
4+
description: "Learn how to configure the items in the AppBar HtmlHelper for {{ site.framework }}."
5+
slug: htmlhelpers_appbar_aspnetcore_items
6+
position: 2
7+
---
8+
9+
# Items
10+
11+
The `Items` represent the content of the AppBar. The `Items` configuration accepts a collection of objects that will be rendered inside the AppBar widget. There are two types of items that developers can choose from:
12+
13+
* [Content Items](#content-items)
14+
* [Spacer](#spacer)
15+
16+
## Content Items
17+
18+
There are two approaches to using templates with **Content Items**:
19+
* You can use the `Template` option exposed by `ContentItem` to consume and render HTML.
20+
* You can supply a `kendo.template` to the configuration by using the `TemplateId` option.
21+
The following example shows how to utilize both of them:
22+
23+
```Razor
24+
@(Html.Kendo().AppBar()
25+
.Name("appbar")
26+
.ThemeColor(AppBarThemeColor.Inherit)
27+
.Items(items=> {
28+
items.Add().Template("<a class='k-button' href='\\#'><span class='k-icon k-i-menu'></span></a>").Type(AppBarItemType.ContentItem);
29+
items.Add().Type(AppBarItemType.Spacer).Width("16px");
30+
items.Add().TemplateId("search-template").Type(AppBarItemType.ContentItem);
31+
})
32+
)
33+
34+
```
35+
36+
## Spacer
37+
38+
The `Spacer` item could be utilized to easily separate the content items from each other.
39+
40+
```Razor
41+
@(Html.Kendo().AppBar()
42+
.Name("appbar")
43+
.Items(items=> {
44+
items.Add().Template("<a class='k-button' href='\\#'><span class='k-icon k-i-menu'></span></a>").Type(AppBarItemType.ContentItem);
45+
items.Add().Type(AppBarItemType.Spacer).Width("16px");
46+
items.Add().Template("<h3>AppBar Demo</h3>").Type(AppBarItemType.ContentItem);
47+
})
48+
)
49+
```
50+
51+
## See Also
52+
53+
* [Overview of the AppBar (Demo)](https://demos.telerik.com/{{ site.platform }}/appbar/index)
54+
* [Server-Side API](/api/appbar)
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Overview
3+
page_title: Overview
4+
description: "Get started with the Telerik UI AppBar HtmlHelper for {{ site.framework }}, and learn how to initialize the component."
5+
slug: htmlhelpers_appbar_aspnetcore_overview
6+
position: 1
7+
---
8+
9+
# AppBar Overview
10+
11+
The Telerik UI AppBar HtmlHelper for {{ site.framework }} is a server-side wrapper for the Kendo UI AppBar widget.
12+
13+
The AppBar component is mainly used for navigation. At the same time, it is template-driven, which makes it very flexible. To take full advantage of its functionality, you can include various [Content Items]({% slug htmlhelpers_appbar_aspnetcore_items %}) in the AppBar component, for example:
14+
* Titles
15+
* Icons
16+
* Actions (such as redirect buttons or a search panel)
17+
18+
Visit the [AppBar demo page](https://demos.telerik.com/{{ site.platform }}/appbar/index) to see it in action.
19+
20+
## Initializing the AppBar
21+
22+
The following example demonstrates how to define the AppBar by using the AppBar HtmlHelper.
23+
24+
```Razor
25+
@(Html.Kendo().AppBar()
26+
.Name("appbar")
27+
)
28+
```
29+
30+
## Functionality and Features
31+
32+
* [Items]({% slug htmlhelpers_appbar_aspnetcore_items %})
33+
* [Position]({% slug htmlhelpers_appbar_aspnetcore_position %})
34+
35+
## See Also
36+
37+
* [Overview of the AppBar (Demo)](https://demos.telerik.com/{{ site.platform }}/appbar/index)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Positioning
3+
page_title: Positioning
4+
description: "Learn how to configure the position of the AppBar HtmlHelper for {{ site.framework }}."
5+
slug: htmlhelpers_appbar_aspnetcore_position
6+
position: 3
7+
---
8+
9+
# Positioning
10+
11+
The AppBar widget enables you to set its [Position](#position) and its [Position mode](#position-mode).
12+
13+
## Position
14+
15+
The `Position` option of the Telerik UI AppBar defines where the widget has to be positioned on the page. The predefined position options are the following:
16+
17+
* `None` - no positioning CSS style are applied
18+
* `Top` - places the AppBar at the top of the page
19+
* `Bottom` - places the AppBar at the bottom of the page
20+
21+
## Position Mode
22+
23+
The `PositionMode` option defines the position of the component relative to its parent container or viewport. The predefined **Position Mode** options are the following:
24+
25+
* `Static` - positions the AppBar according to the normal flow of the page.
26+
* `Sticky` - sticks the AppBar to a given position(top or bottom).
27+
* `Fixed`- positions the AppBar relative to the viewport.
28+
29+
> In order to use the `Sticky` or `Fixed` position mode of the AppBar, the `Position` has to be set either to `Top` or `Bottom`.
30+
31+
## See Also
32+
33+
* [Positioning of the AppBar (Demo)](https://demos.telerik.com/{{ site.platform }}/appbar/position)
34+
* [Server-Side API](/api/appbar)

docs/_config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,8 @@ navigation:
183183
position: 70
184184
"controls/navigation":
185185
title: "Navigation"
186+
"controls/navigation/appbar":
187+
title: "AppBar"
186188
"controls/navigation/breadcrumb":
187189
title: "Breadcrumb"
188190
"controls/navigation/buttongroup":
@@ -2054,6 +2056,7 @@ intro_columns:
20542056
-
20552057
title: "Navigation"
20562058
items:
2059+
"AppBar": "overview_kendoui_appbar_widget"
20572060
"Breadcrumb": "overview_kendoui_breadcrumb_widget"
20582061
"Button": "overview_kendoui_button_widget"
20592062
"ButtonGroup": "overview_kendoui_buttongroup_widget"

0 commit comments

Comments
 (0)