Skip to content

documentation(962309):Added sticky header topic. #4253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 9, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<div style="height: 400px; overflow-y: auto; padding: 0px 10px 0px 10px; border: 1px solid #ddd;">
<div style="padding: 20px 0px 20px 0px; display: flex">
<label style="margin: 0px 5px 0px 0px;font-weight: bold;">Enable/Disable Sticky Header</label>
@Html.EJS().Switch("switch").Change("toggleStickyHeader").Render()
</div>
<div style='height: 1000px'>
@(Html.EJS().TreeGrid("TreeGrid").DataSource((IEnumerable<object>)ViewBag.datasource).Height("100%").Columns(col =>
{
col.Field("TaskId").HeaderText("Task ID").Width(90).TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
col.Field("TaskName").HeaderText("Task Name").Width(180).Add();
col.Field("StartDate").HeaderText("Start Date").Format("yMd").Type("date").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Width(120).Add();
col.Field("Duration").HeaderText("Duration").Width(110).TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
}).ChildMapping("Children").TreeColumnIndex(1).EnableStickyHeader(true).Render())
</div>
</div>

<script>
function toggleStickyHeader(args) {
var treeGrid = document.getElementById("TreeGrid").ej2_instances[0];
treeGrid.enableStickyHeader = args.checked ?? false;
}
</script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
public IActionResult Index()
{
var tree = TreeGridItems.GetTreeData();
ViewBag.datasource = tree;
return View();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@

<div style="height: 400px; overflow-y: auto; padding: 0px 10px 0px 10px; border: 1px solid #ddd;">
<div style="padding: 20px 0px 20px 0px; display: flex">
<label style="margin: -2px 5px 0px 0px; font-weight: bold;">Enable/Disable Sticky Header</label>
<ejs-switch id="switch" checked="true" change="toggleStickyHeader"></ejs-switch>
</div>
<div style='height: 1000px'>
<ejs-treegrid id="TreeGrid" dataSource="@ViewBag.datasource" childMapping="Children" treeColumnIndex="1" enableStickyHeader="true" height="100%">
<e-treegrid-columns>
<e-treegrid-column field="TaskId" headerText="Task ID" textAlign="Right" width="90"></e-treegrid-column>
<e-treegrid-column field="TaskName" headerText="Task Name" width="180"></e-treegrid-column>
<e-treegrid-column field="StartDate" headerText="Start Date" textAlign="Right" format="yMd" type="date" width="120"></e-treegrid-column>
<e-treegrid-column field="Duration" headerText="Duration" textAlign="Right" width="110"></e-treegrid-column>
</e-treegrid-columns>
</ejs-treegrid>
</div>
</div>

<script>
function toggleStickyHeader(args) {
var treeGrid = document.getElementById("TreeGrid").ej2_instances[0];
treeGrid.enableStickyHeader = args.checked ?? false;
}
</script>
19 changes: 18 additions & 1 deletion ej2-asp-core-mvc/tree-grid/EJ2_ASP.MVC/scrolling.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: post
title: Scrolling in ##Platform_Name## Tree Grid Component
title: Scrolling in Syncfusion ##Platform_Name## Tree Grid Component
description: Learn here all about Scrolling in Syncfusion ##Platform_Name## Tree Grid component of Syncfusion Essential JS 2 and more.
platform: ej2-asp-core-mvc
control: Scrolling
Expand Down Expand Up @@ -76,7 +76,24 @@ Setting the [`Height`](https://help.syncfusion.com/cr/cref_files/aspnetcore-js2/
{% endtabs %}
{% endif %}

## Sticky header

The Syncfusion ASP.NET MVC TreeGrid provides a useful feature to keep the column headers fixed (sticky) while scrolling through large datasets. This ensures that the headers remain visible at all times, enhancing user experience by making it easier to understand the context of the data displayed, especially when dealing with wide or long hierarchical data.

For example, in a project management application, users often need to scroll through a detailed list of tasks and subtasks. When the dataset is large, scrolling down can cause confusion if the column headers scroll out of view, making it difficult to remember what each column represents. By enabling sticky headers, the column headers remain visible even while scrolling, allowing users to easily keep track of the data context.

To enable sticky headers in the TreeGrid, you can simply set the `EnableStickyHeader` property to **true**. This makes the column headers stick to the top of the TreeGrid container or its parent scrolling container when you scroll vertically.

The following sample demonstrates how to enable or disable the sticky header in the TreeGrid using a [Switch](https://ej2.syncfusion.com/aspnetmvc/documentation/switch/getting-started) and its [Change](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Buttons.Switch.html#Syncfusion_EJ2_Buttons_Switch_Change) event:

{% tabs %}
{% highlight cshtml tabtitle="CSHTML" %}
{% include code-snippet/tree-grid/scrolling/scrolling-sticky-header/razor %}
{% endhighlight %}
{% highlight c# tabtitle="sticky-header.cs" %}
{% include code-snippet/tree-grid/scrolling/scrolling-sticky-header/sticky-header.cs%}
{% endhighlight %}
{% endtabs %}

## Scroll to selected row

Expand Down
17 changes: 17 additions & 0 deletions ej2-asp-core-mvc/tree-grid/EJ2_ASP.NETCORE/scrolling.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,24 @@ Specify the [`width`](https://help.syncfusion.com/cr/cref_files/aspnetcore-js2/S
{% endtabs %}
{% endif %}

## Sticky header

The Syncfusion ASP.NET MVC TreeGrid provides a useful feature to keep the column headers fixed (sticky) while scrolling through large datasets. This ensures that the headers remain visible at all times, enhancing user experience by making it easier to understand the context of the data displayed, especially when dealing with wide or long hierarchical data.

For example, in a project management application, users often need to scroll through a detailed list of tasks and subtasks. When the dataset is large, scrolling down can cause confusion if the column headers scroll out of view, making it difficult to remember what each column represents. By enabling sticky headers, the column headers remain visible even while scrolling, allowing users to easily keep track of the data context.

To enable sticky headers in the TreeGrid, you can simply set the `EnableStickyHeader` property to **true**. This makes the column headers stick to the top of the TreeGrid container or its parent scrolling container when you scroll vertically.

The following sample demonstrates how to enable or disable the sticky header in the TreeGrid using a [Switch](https://ej2.syncfusion.com/aspnetmvc/documentation/switch/getting-started) and its [Change](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Buttons.Switch.html#Syncfusion_EJ2_Buttons_Switch_Change) event:

{% tabs %}
{% highlight cshtml tabtitle="CSHTML" %}
{% include code-snippet/tree-grid/scrolling/scrolling-sticky-header/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="sticky-header.cs" %}
{% include code-snippet/tree-grid/scrolling/scrolling-sticky-header/sticky-header.cs%}
{% endhighlight %}
{% endtabs %}

## Scroll to selected row

Expand Down