Skip to content

[DataGrid] Add method to close column options programmatically #3501

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.

Sign up for GitHub

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
vnbaaij merged 2 commits into from
Mar 12, 2025
Merged

[DataGrid] Add method to close column options programmatically #3501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb9c6c9
Add CloseColumnOptionsAsync method
vnbaaij Mar 11, 2025
5d4dfff
Merge branch 'dev' into users/vnbaaij/datagrid-close-columnoptions
dvoituron Mar 12, 2025
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
5 changes: 5 additions & 0 deletions examples/Demo/Shared/Microsoft.FluentUI.AspNetCore.Components.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2141,6 +2141,11 @@
<param name="index">The column index whose options UI is to be displayed.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completion of the operation.</returns>
</member>
<member name="M:Microsoft.FluentUI.AspNetCore.Components.FluentDataGrid`1.CloseColumnOptionsAsync">
<summary>
Closes the <see cref="P:Microsoft.FluentUI.AspNetCore.Components.ColumnBase`1.ColumnOptions"/> UI that was previously displayed.
</summary>
</member>
<member name="M:Microsoft.FluentUI.AspNetCore.Components.FluentDataGrid`1.ShowColumnResizeAsync(Microsoft.FluentUI.AspNetCore.Components.ColumnBase{`0})">
<summary>
Displays the column resize UI for the specified column, closing any other column
Expand Down
18 changes: 16 additions & 2 deletions examples/Demo/Shared/Pages/DataGrid/Examples/DataGridTypical.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
<p>Remove the parameter completely to get the original behavior</p>

<div style="height: 380px; overflow-x:auto; display:flex;">
<FluentDataGrid Items="@FilteredItems"
<FluentDataGrid @ref="grid"
Items="@FilteredItems"
ResizableColumns=true
ResizeType="DataGridResizeType.Discrete"
GridTemplateColumns="0.3fr 1fr 0.2fr 0.2fr 0.2fr 0.2fr"
Expand All @@ -19,7 +20,7 @@
<PropertyColumn Property="@(c => c.Name)" Sortable="true" Filtered="!string.IsNullOrWhiteSpace(nameFilter)" Tooltip="true" Title="Name of the country">
<ColumnOptions>
<div class="search-box">
<FluentSearch Autofocus=true @bind-Value=nameFilter @oninput="HandleCountryFilter" @bind-Value:after="HandleClear" Placeholder="Country name..." Style="width: 100%;" Label="Filter" />
<FluentSearch Autofocus=true @bind-Value=nameFilter @oninput="HandleCountryFilter" @onkeydown="HandleCloseFilterAsync" @bind-Value:after="HandleClear" Placeholder="Country name..." Style="width: 100%;" Label="Filter" />
</div>
</ColumnOptions>
</PropertyColumn>
Expand Down Expand Up @@ -57,6 +58,7 @@
</FluentSwitch>

@code {
FluentDataGrid<Country>? grid;
bool _clearItems = false;
IQueryable<Country>? items;
PaginationState pagination = new PaginationState { ItemsPerPage = 10 };
Expand Down Expand Up @@ -117,6 +119,18 @@
}
}

private async Task HandleCloseFilterAsync(KeyboardEventArgs args)
{
if (args.Key == "Escape")
{
nameFilter = string.Empty;
}
if (args.Key == "Enter" && grid is not null)
{
await grid.CloseColumnOptionsAsync();
}
}

private async Task ToggleItemsAsync()
{
if (_clearItems)
Expand Down
4 changes: 4 additions & 0 deletions examples/Demo/Shared/Pages/DataGrid/Pages/DataGridTypicalPage.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,9 @@
<code>TooltipText</code> is a lambda function that takes the current item as input and returns the text to show in the tooltip (and <code>aria-label</code>).
Look at the Razor tab to see how this is done and how it can be customized.
</p>
<p>
The Country filter option can be used to quickly filter the list of countries shown. Pressing the ESC key just closes the option popup without changing the filtering currently being used.
Pressing enter finishes the filter action by the current input to filter on and closes the option popup.
</p>
</Description>
</DemoSection>
10 changes: 10 additions & 0 deletions src/Core/Components/DataGrid/FluentDataGrid.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,16 @@ public Task ShowColumnOptionsAsync(int index)
return (index >= 0 && index < _columns.Count) ? ShowColumnOptionsAsync(_columns[index]) : Task.CompletedTask;
}

/// <summary>
/// Closes the <see cref="ColumnBase{TGridItem}.ColumnOptions"/> UI that was previously displayed.
/// </summary>
public Task CloseColumnOptionsAsync()
{
_displayOptionsForColumn = null;
StateHasChanged();
return Task.CompletedTask;
}

/// <summary>
/// Displays the column resize UI for the specified column, closing any other column
/// resize UI that was previously displayed.
Expand Down