Skip to content

Commit

Permalink
Sync with Kendo UI Professional
Browse files Browse the repository at this point in the history
  • Loading branch information
Kendo Bot committed Apr 19, 2021
1 parent 69ed196 commit 582ddc1
Show file tree
Hide file tree
Showing 22 changed files with 3,117 additions and 29 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ Kendo UI Core is a free and open-source subset of Kendo UI. The following table
| [Waterfall Charts](https://demos.telerik.com/kendo-ui/waterfall-charts/index) | :x: | :white_check_mark: | :white_check_mark: |
| **Gauges** |
| [ArcGauge](https://demos.telerik.com/kendo-ui/arc-gauge/index) | :x: | :white_check_mark: | :white_check_mark: |
| [CircularGauge](https://demos.telerik.com/kendo-ui/circular-gauge/index) | :x: | :white_check_mark: | :white_check_mark: |
| [LinearGauge](https://demos.telerik.com/kendo-ui/linear-gauge/index) | :x: | :white_check_mark: | :white_check_mark: |
| [RadialGauge](https://demos.telerik.com/kendo-ui/radial-gauge/index) | :x: | :white_check_mark: | :white_check_mark: |
| **Barcodes** |
Expand Down
10 changes: 10 additions & 0 deletions docs-aspnet/_config-mvc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,11 @@ defaults:
path: "html-helpers/gauges/arcgauge"
values:
title_prefix: "ASP.NET MVC ArcGauge Component"
-
scope:
path: "html-helpers/gauges/circulargauge"
values:
title_prefix: "ASP.NET MVC CircularGauge Component"
-
scope:
path: "html-helpers/gauges/lineargauge"
Expand All @@ -397,6 +402,11 @@ defaults:
values:
title_prefix: "ASP.NET MVC Loader Component"
-
scope:
path: "html-helpers/interactivity/skeletoncontainer"
values:
title_prefix: "ASP.NET MVC SkeletonContainer Component"

scope:
path: "html-helpers/interactivity/progressbar"
values:
Expand Down
30 changes: 29 additions & 1 deletion docs-aspnet/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ navigation:
position: 280
"api":
title: "API Reference"
position: 0
position: 0
"getting-started":
title: "Getting Started"
position: 2
Expand Down Expand Up @@ -244,6 +244,8 @@ navigation:
title: "Interactivity and UX"
"tag-helpers/interactivity/loader":
title: "Loader"
"tag-helpers/interactivity/skeletoncontainer":
title: "SkeletonContainer"
"tag-helpers/media":
title: "Media"
"tag-helpers/pdf":
Expand Down Expand Up @@ -394,6 +396,8 @@ navigation:
title: "Interactivity and UX"
"html-helpers/interactivity/loader":
title: "Loader"
"html-helpers/interactivity/skeletoncontainer":
title: "SkeletonContainer"
"html-helpers/interactivity/sortable/integration":
title: "Integration"
position: 6
Expand Down Expand Up @@ -452,6 +456,8 @@ navigation:
title: "Spreadsheet"
"*arcgauge":
title: "ArcGauge"
"*circulargauge":
title: "CircularGauge"
"*autocomplete":
title: "AutoComplete"
"*barcode":
Expand Down Expand Up @@ -518,6 +524,8 @@ navigation:
title: "Image Editor"
"*loader":
title: "Loader"
"*SkeletonContainer":
title: "SkeletonContainer"
"*lineargauge":
title: "LinearGauge"
"*listbox":
Expand Down Expand Up @@ -875,6 +883,11 @@ defaults:
path: "html-helpers/gauges/arcgauge"
values:
title_prefix: "ASP.NET Core ArcGauge Component"
-
scope:
path: "html-helpers/gauges/circulargauge"
values:
title_prefix: "ASP.NET Core CircularGauge Component"
-
scope:
path: "html-helpers/gauges/lineargauge"
Expand All @@ -895,6 +908,11 @@ defaults:
path: "html-helpers/interactivity/loader"
values:
title_prefix: "ASP.NET Core Loader Component"

scope:
path: "html-helpers/interactivity/skeletoncontainer"
values:
title_prefix: "ASP.NET Core SkeletonContainer Component"
-
scope:
path: "html-helpers/interactivity/progressbar"
Expand Down Expand Up @@ -1295,6 +1313,11 @@ defaults:
path: "tag-helpers/gauges/arcgauge"
values:
title_prefix: "ASP.NET Core ArcGauge Component"
-
scope:
path: "tag-helpers/gauges/circulargauge"
values:
title_prefix: "ASP.NET Core CircularGauge Component"
-
scope:
path: "tag-helpers/gauges/lineargauge"
Expand All @@ -1316,6 +1339,11 @@ defaults:
values:
title_prefix: "ASP.NET Core Loader Component"
-
scope:
path: "tag-helpers/interactivity/skeletoncontainer"
values:
title_prefix: "ASP.NET Core SkeletonContainer Component"

scope:
path: "tag-helpers/interactivity/progressbar"
values:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@
</li>
<li>
<a href="/{{ site.platform }}/html-helpers/editors/upload/razor-page">Upload</a>
</li>
</li>
</ul>
</td>
<td>
Expand Down Expand Up @@ -208,6 +208,9 @@
<li>
ArcGauge
</li>
<li>
CircularGauge
</li>
<li>
LinearGauge
</li>
Expand Down
71 changes: 71 additions & 0 deletions docs-aspnet/html-helpers/data-management/treelist/persist-state.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: State Persistence
page_title: State Persistence
description: "Get started with the Telerik UI TreeList HtmlHelper for {{ site.framework }} and persist the state of the widget."
slug: htmlhelpers_treelist_aspnetcore_persiststate
position: 9
---

# State Persistence

The TreeList component enables you to store the custom settings of the user and restore them when the user logs back in at some future moment. This feature is known as state persistence.

To persist the settings that were previously applied to its structure, use the `getOptions` and `setOptions` methods of the TreeList. These methods allow you to serialize the current state of the TreeList if needed and recover that state later.

The following example demonstrates how to automatically maintain an up-to-date state of the TreeList. Upon a page reload, the stored settings will be provided to the TreeList configuration and will be applied.

```View
@(Html.Kendo().TreeList<Kendo.Mvc.Examples.Models.TreeList.EmployeeDirectoryModel>()
.Name("treelist")
.Columns(columns =>
{
columns.Add().Field(e => e.FirstName).Title("First Name").Width(250);
columns.Add().Field(e => e.LastName).Title("Last Name");
columns.Add().Field(e => e.Position);
columns.Add().Field(e => e.Extension).Title("Ext").Format("{0:#}").Filterable(false);
})
.Filterable(true)
.Sortable(true)
.Reorderable(true)
.Resizable(true)
.ColumnMenu()
.DataSource(dataSource => dataSource
.ServerOperation(false)
.Read(read => read.Action("All", "EmployeeDirectory"))
.Model(m =>
{
m.Id(f => f.EmployeeId);
m.ParentId(f => f.ReportsTo);
m.Expanded(true);
m.Field(f => f.FirstName);
m.Field(f => f.LastName);
m.Field(f => f.ReportsTo);
m.Field(f => f.Position);
m.Field(f => f.Extension);
})
)
.Height(540)
)
<script>
$(document).ready(function () {
var treeList = $("#treelist").data("kendoTreeList");
var options = localStorage["kendo-treelist-options"];
if (options) {
treeList.setOptions(JSON.parse(options)); // Load the stored TreeList options after its initialization
}
$(window).on( "unload", function(e){
e.preventDefault();
localStorage["kendo-treelist-options"] = kendo.stringify(treeList.getOptions()); // Get and store the TreeList settings when navigating away from the page
});
});
</script>
```

## See Also

* [Persisting the State of the TreeList HtmlHelper for {{ site.framework }} (Demo)](https://demos.telerik.com/{{ site.platform }}/treelist/persist-state)
* [Server-Side API](/api/treelist)
54 changes: 54 additions & 0 deletions docs-aspnet/html-helpers/interactivity/skeletoncontainer/items.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Items
page_title: Items
description: "Learn how to configure the items in the SkeletonContaienr HtmlHelper for {{ site.framework }}."
slug: htmlhelpers_skeletoncontainer_aspnetcore_items
position: 2
---

# Items

The Telerik UI SkeletonContainer HtmlHelper for {{ site.framework }} uses the default [CSS Grid](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout) layout as a base. Each cell or group of cells from the CSS Grid can be represented by an item from the SkeletonContainer.

Each item contains the following properties:

* `ColStart` - indicates the starting column of the item.
* `ColSpan` - indicates how many columns the item will occupy.
* `CowStart` - indicates the starting row of the item.
* `RowSpan` - indicates how many rows the item will occupy
* `Shape` - the type of shape that will fill the selected cells.

The following example shows how to create a SkeletonContainer using a grid featuring all shape types:

```Razor
@(Html.Kendo().SkeletonContainer()
.Name("skeleton")
.Height("340px")
.Width("350px")
.Animation(SkeletonContainerAnimation.Pulse)
.Grid(g=> {
g.Rows(20);
g.Columns(20);
g.Items(i=> {
i.Add().ColStart(2).ColSpan(4).RowStart(2).RowSpan(4).Shape(SkeletonContainerItemShape.Circle);
i.Add().ColStart(7).ColSpan(13).RowStart(2).RowSpan(2).Shape(SkeletonContainerItemShape.Text);
i.Add().ColStart(7).ColSpan(9).RowStart(4).RowSpan(2).Shape(SkeletonContainerItemShape.Text);
i.Add().ColStart(1).ColSpan(20).RowStart(7).RowSpan(11).Shape(SkeletonContainerItemShape.Rectangle);
i.Add().ColStart(2).ColSpan(18).RowStart(19).RowSpan(1).Shape(SkeletonContainerItemShape.Text);
});
})
)
```
```CSS
<style>
#skeleton {
border: 1px solid;
border-color: rgba(0, 0, 0, 0.08);
}
</style>
```

## See Also

* [Overview of the SkeletonContainer (Demo)](https://demos.telerik.com/{{ site.platform }}/skeletoncontainer/index)
* [Server-Side API](/api/skeletoncontainer)
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Overview
page_title: Overview
description: "Learn the basics when working with the Telerik UI SkeletonContainer HtmlHelper for {{ site.framework }}."
slug: htmlhelpers_skeletoncontainer_aspnetcore_overview
position: 1
---

# SkeletonContainer Overview

The Telerik UI SkeletonContainer HtmlHelper for {{ site.framework }} is a server-side wrapper for the Kendo UI SkeletonContainer widget.

The SkeletonContainer widget indicates to the user that the content is coming but has not yet been loaded. It aims at helping the user focus on progress and makes the page load time appear shorter.

A SkeletonContainer is basically a simplified preview version of a page into which information is gradually loaded (i.e. via AJAX requests).

## Initializing the SkeletonContainer

It is recommended to initialize the widget from a div HTML element.

The following example demonstrates how to initialize the SkeletonContainer from an existing `<div>` element.

```Razor
@(Html.Kendo().SkeletonContainer()
.Name("skeleton")
)
```

## Functionality and Features

The Telerik UI SkeletonContainer for {{ site.framework }} accepts either a template or a CSS Grid. While the developer can pass merely anything at the template, the CSS Grid exposes an `Item` object that has a set of predefined properties. Find out more about the CSS Grid setup here:

* [Items]({% slug htmlhelpers_skeletoncontainer_aspnetcore_items %})

## See Also

* [Overview of the SkeletonContainer HtmlHelper for {{ site.framework }} (Demo)](https://demos.telerik.com/{{ site.platform }}/skeletoncontainer/index)
* [Server-Side API](/api/skeletoncontainer)
3 changes: 3 additions & 0 deletions docs-aspnet/list-of-helpers.html
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,9 @@
<li>
<a href="/{{ site.platform }}/html-helpers/gauges/arcgauge/overview">ArcGauge</a>
</li>
<li>
<a href="/{{ site.platform }}/html-helpers/gauges/circulargauge/overview">CircularGauge</a>
</li>
<li>
<a href="/{{ site.platform }}/html-helpers/gauges/lineargauge/overview">LinearGauge</a>
</li>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Overview
page_title: Overview
description: "Learn the basics when working with the Telerik UI SkeletonContainer TagHelper for ASP.NET Core (MVC 6 or ASP.NET Core MVC)."
slug: taghelpers_skeletoncontainer_aspnetcore
position: 1
---

# SkeletonContainer TagHelper Overview

The Telerik UI SkeletonContainer TagHelper for ASP.NET Core is a server-side wrapper for the Kendo UI SkeletonContainer widget.

The SkeletonContainer widget indicates to the user that the content is coming but has not yet been loaded. It aims at helping the user focus on progress and makes the page load time appear shorter.

A SkeletonContainer is basically a simplified preview version of a page into which information is gradually loaded (i.e. via AJAX requests).

## Initializing the SkeletonContainer

The SkeletonContainer TagHelper configuration options are passed as attributes of the tag.

```tagHelper
<kendo-skeletoncontainer name="skeleton" animation="SkeletonContainerAnimation.Pulse"
template-id="tmpl">
</kendo-skeletoncontainer>
```
```JavaScript
<script id="tmpl" type="text/html">
<div class='k-card'>
<div class='k-card-header'>
<div>
<span data-shape-circle class='k-card-image avatar'></span>
</div>
<div class='user-info'>
<span data-shape-text class='k-card-title'></span>
<span data-shape-text class='k-card-subtitle'></span>
</div>
</div>
<span data-shape-rectangle style='width: 340px; height: 225px; '></span>
<div class='k-card-body'>
<span data-shape-text></span>
</div>
</div>
</script>
```

## See Also

* [Basic Usage of the SkeletonContainer TagHelper for ASP.NET Core (Demo)](https://demos.telerik.com/aspnet-core/skeletoncontainer/tag-helper)
* [Server-Side API](/api/skeletoncontainer)
Loading

0 comments on commit 582ddc1

Please sign in to comment.