Skip to content
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

[Dialog] Add event before closing panel to allow validation of the data provided by the user #2614

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
Expand Up @@ -3660,6 +3660,14 @@
This method is only called when using the <see cref="T:Microsoft.FluentUI.AspNetCore.Components.IDialogService"/>.
</remarks>
</member>
<member name="P:Microsoft.FluentUI.AspNetCore.Components.DialogParameters.OnDialogValidation">
<summary>
Function that is called and awaited before the dialog is closed.
</summary>
<remarks>
This is a suitable callback to use when you need to validate the data in the dialog <em>before</em> it closes.
</remarks>
</member>
<member name="T:Microsoft.FluentUI.AspNetCore.Components.DialogParameters`1">
<summary>
Parameters for a dialog.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
@inject IDialogService DialogService
@inject IMessageService MessageService

<FluentButton @onclick="@OpenPanelRightAsync" Appearance="Appearance.Accent">
Open panel (&gt;&gt;)
</FluentButton>
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// ------------------------------------------------------------------------
// MIT License - Copyright (c) Microsoft Corporation. All rights reserved.
// ------------------------------------------------------------------------

using FluentUI.Demo.Shared.SampleData;
using Microsoft.FluentUI.AspNetCore.Components;

namespace FluentUI.Demo.Shared.Pages.Panel.Examples;
public partial class DialogPanelWithValidation
{
private IDialogReference? _dialog;

private readonly SimplePerson simplePerson = new()
{
Firstname = "Steve",
Lastname = "Roth",
Age = 42,
};

private async Task OpenPanelRightAsync()
{
DemoLogger.WriteLine($"Open right panel");

MessageService.Clear();

_dialog = await DialogService.ShowPanelAsync<SimplePanel>(simplePerson, new DialogParameters<SimplePerson>()
{
Content = simplePerson,
Alignment = HorizontalAlignment.Right,
Title = $"Hello {simplePerson.Firstname}",
PrimaryAction = "Yes",
SecondaryAction = "No",
PreventDismissOnOverlayClick = true,
OnDialogValidation = async () =>
{
var result = simplePerson.Firstname.Length > 0 && simplePerson.Lastname.Length > 0;

if (!result)
{
DemoLogger.WriteLine("Panel cannot be closed because of validation errors.");

MessageService.ShowMessageBar(options =>
{
options.Intent = MessageIntent.Error;
options.Title = "Validation error";
options.Body = "First name and last name cannot be empty";
options.Timestamp = DateTime.Now;
options.Section = App.MESSAGES_DIALOG;
});
}

await Task.Delay(100);

return result;
}
});

DialogResult result = await _dialog.Result;
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
@implements IDialogContentComponent<SimplePerson>

<FluentMessageBarProvider Section="@App.MESSAGES_DIALOG" MaxMessageCount="1" />

<FluentDialogBody>
<h3>Hello @Content.Firstname </h3>
<p>Your lastname is @Content.Lastname and you are @Content.Age years young </p>
Expand All @@ -12,4 +14,4 @@
@code {
[Parameter]
public SimplePerson Content { get; set; } = default!;
}
}
8 changes: 8 additions & 0 deletions examples/Demo/Shared/Pages/Panel/PanelPage.razor
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,14 @@
</Description>
</DemoSection>

<DemoSection Title="Panels with validation" Component="@typeof(DialogPanelWithValidation)" CollocatedFiles="@(new[] { "cs" })" AdditionalFiles="@(new[] {"SimplePanel.razor"})">
<Description>
The panel that is anchored to the right side of the screen can be dismissed by clicking the dismiss button (at the top),
'No' button (at the bottom) or 'Yes' button (at the bottom). <br />
Before the panel is closed, it will validate the data and, if not ok, will prevent the dialog from closing using the 'Yes' button.
</Description>
</DemoSection>

<h2 id="documentation">Documentation</h2>

<ApiDocumentation Component="typeof(DialogParameters<>)" InstanceTypes="@(new[] {typeof(string)})" GenericLabel="TData" />
10 changes: 10 additions & 0 deletions src/Core/Components/Dialog/FluentDialog.razor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,16 @@ public async Task CloseAsync(DialogResult dialogResult)
{
await Instance.Parameters.OnDialogClosing.InvokeAsync(Instance);
}

if (Instance.Parameters.OnDialogValidation != null && !dialogResult.Cancelled)
{
var isValid = await Instance.Parameters.OnDialogValidation();

if (!isValid)
{
return;
}
}
}
DialogContext?.DialogContainer.DismissInstance(Id!, dialogResult);
if (Instance is not null)
Expand Down
8 changes: 8 additions & 0 deletions src/Core/Components/Dialog/Parameters/DialogParameters.cs
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,14 @@ public virtual HorizontalAlignment Alignment
/// This method is only called when using the <see cref="IDialogService"/>.
/// </remarks>
public EventCallback<DialogInstance> OnDialogOpened { get; set; } = default!;

/// <summary>
/// Function that is called and awaited before the dialog is closed.
/// </summary>
/// <remarks>
/// This is a suitable callback to use when you need to validate the data in the dialog <em>before</em> it closes.
/// </remarks>
public Func<Task<bool>> OnDialogValidation { get; set; } = default!;
}

/// <summary>
Expand Down