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

#206 | Renamed BlazoredModalInstance Close and Cancel to CloseAsync and CancelAsync #258

Merged
merged 2 commits into from
Nov 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ If you want to pass values to the component you're displaying in the modal, then
void SaveMovie()
{
MovieService.Save(Movie);
BlazoredModal.Close(ModalResult.Ok<Movie>(Movie));
BlazoredModal.CloseAsync(ModalResult.Ok<Movie>(Movie));
}

}
Expand Down Expand Up @@ -266,12 +266,12 @@ In the example below, when the form is submitted a `ModalResult.Ok` containing t

void SubmitForm()
{
BlazoredModal.Close(ModalResult.Ok($"Form was submitted successfully."));
BlazoredModal.CloseAsync(ModalResult.Ok($"Form was submitted successfully."));
}

void Cancel()
{
BlazoredModal.Cancel();
BlazoredModal.CancelAsync();
}

}
Expand Down Expand Up @@ -476,12 +476,12 @@ Below is a component which being displayed inside a Blazored Modal instance. Whe
if (result.Cancelled)
return;

BlazoredModal.Close(ModalResult.Ok($"The user said 'Yes'"));
BlazoredModal.CloseAsync(ModalResult.Ok($"The user said 'Yes'"));
}

void No()
{
BlazoredModal.Close(ModalResult.Cancel());
BlazoredModal.CloseAsync(ModalResult.Cancel());
}

}
Expand Down
4 changes: 2 additions & 2 deletions samples/BlazorServer/Shared/Confirm.razor
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }

void Close() => BlazoredModal.Close(ModalResult.Ok(true));
void Cancel() => BlazoredModal.Cancel();
async Task Close() => await BlazoredModal.CloseAsync(ModalResult.Ok(true));
async Task Cancel() =>await BlazoredModal.CancelAsync();

}
4 changes: 2 additions & 2 deletions samples/BlazorServer/Shared/CustomBootstrapModal.razor
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

[Parameter] public string Message { get; set; }

async Task Close() => await BlazoredModal.Close(ModalResult.Ok(true));
async Task Cancel() => await BlazoredModal.Cancel();
async Task Close() => await BlazoredModal.CloseAsync(ModalResult.Ok(true));
async Task Cancel() => await BlazoredModal.CancelAsync();

}
4 changes: 2 additions & 2 deletions samples/BlazorServer/Shared/DisplayMessage.razor
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

[Parameter] public string Message { get; set; }

void SubmitForm() => BlazoredModal.Close();
void Cancel() => BlazoredModal.Cancel();
async Task SubmitForm() => await BlazoredModal.CloseAsync();
async Task Cancel() => await BlazoredModal.CancelAsync();

}
8 changes: 4 additions & 4 deletions samples/BlazorServer/Shared/FullContentPage.razor
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@

@code {

[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }
[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }
[Parameter] public string Message { get; set; }

void SubmitForm() => BlazoredModal.Close();
void Cancel() => BlazoredModal.Cancel();
async Task SubmitForm() => await BlazoredModal.CloseAsync();
async Task Cancel() => await BlazoredModal.CancelAsync();

}
8 changes: 4 additions & 4 deletions samples/BlazorServer/Shared/MessageForm.razor
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

string Message { get; set; }

protected override void OnInitialized() => BlazoredModal.SetTitle("Enter a Message");
void SubmitForm() => BlazoredModal.Close(ModalResult.Ok(Message));
void Cancel() => BlazoredModal.Cancel();
protected override void OnInitialized() => BlazoredModal.SetTitle("Enter a Message");
async Task SubmitForm() => await BlazoredModal.CloseAsync(ModalResult.Ok(Message));
async Task Cancel() => await BlazoredModal.CancelAsync();

}
8 changes: 4 additions & 4 deletions samples/BlazorServer/Shared/YesNoPrompt.razor
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
if (result.Cancelled)
return;

BlazoredModal.Close();
}

void No() => BlazoredModal.Cancel();
await BlazoredModal.CloseAsync();
}
async Task No() => await BlazoredModal.CancelAsync();

}
8 changes: 4 additions & 4 deletions samples/BlazorServer/Shared/YesNoPromptAnimation.razor
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
if (result.Cancelled)
return;

BlazoredModal.Close();
}

void No() => BlazoredModal.Cancel();
await BlazoredModal.CloseAsync();
}
async Task No() => await BlazoredModal.CancelAsync();

}
8 changes: 4 additions & 4 deletions samples/BlazorWebAssembly/Shared/Confirm.razor
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

@code {

[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }

void Close() => BlazoredModal.Close(ModalResult.Ok(true));
void Cancel() => BlazoredModal.Cancel();
[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }
async Task Close() => await BlazoredModal.CloseAsync(ModalResult.Ok(true));
async Task Cancel() => await BlazoredModal.CancelAsync();

}
4 changes: 2 additions & 2 deletions samples/BlazorWebAssembly/Shared/CustomBootstrapModal.razor
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

[Parameter] public string Message { get; set; }

async Task Close() => await BlazoredModal.Close(ModalResult.Ok(true));
async Task Cancel() => await BlazoredModal.Cancel();
async Task Close() => await BlazoredModal.CloseAsync(ModalResult.Ok(true));
async Task Cancel() => await BlazoredModal.CancelAsync();

}
8 changes: 4 additions & 4 deletions samples/BlazorWebAssembly/Shared/DisplayMessage.razor
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

@code {

[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }
[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }
[Parameter] public string Message { get; set; }

void SubmitForm() => BlazoredModal.Close();
void Cancel() => BlazoredModal.Cancel();
async Task SubmitForm() => await BlazoredModal.CloseAsync();
async Task Cancel() => await BlazoredModal.CancelAsync();

}
8 changes: 4 additions & 4 deletions samples/BlazorWebAssembly/Shared/FullContentPage.razor
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@

@code {

[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }
[CascadingParameter] BlazoredModalInstance BlazoredModal { get; set; }
[Parameter] public string Message { get; set; }

void SubmitForm() => BlazoredModal.Close();
void Cancel() => BlazoredModal.Cancel();
async Task SubmitForm() => await BlazoredModal.CloseAsync();
async Task Cancel() => await BlazoredModal.CancelAsync();

}
4 changes: 2 additions & 2 deletions samples/BlazorWebAssembly/Shared/MessageForm.razor
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@

protected override void OnInitialized() => BlazoredModal.SetTitle("Enter a Message");

async Task SubmitForm() => await BlazoredModal.Close(ModalResult.Ok(_form.Message));
async Task Cancel() => await BlazoredModal.Cancel();
async Task SubmitForm() => await BlazoredModal.CloseAsync(ModalResult.Ok(_form.Message));
async Task Cancel() => await BlazoredModal.CancelAsync();

public class Form
{
Expand Down
4 changes: 2 additions & 2 deletions samples/BlazorWebAssembly/Shared/YesNoPrompt.razor
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
if (result.Cancelled)
return;

BlazoredModal.Close();
await BlazoredModal.CloseAsync();
}

void No() => BlazoredModal.Cancel();
async Task No() => await BlazoredModal.CancelAsync();

}
8 changes: 4 additions & 4 deletions samples/BlazorWebAssembly/Shared/YesNoPromptAnimation.razor
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
if (result.Cancelled)
return;

BlazoredModal.Close();
}

void No() => BlazoredModal.Cancel();
await BlazoredModal.CloseAsync();
}
async Task No() => await BlazoredModal.CancelAsync();

}
2 changes: 1 addition & 1 deletion src/Blazored.Modal/BlazoredModal.razor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ internal async void CloseInstance(ModalReference modal, ModalResult result)
if (modal.ModalInstanceRef != null)
{
// Gracefully close the modal
await modal.ModalInstanceRef.Close(result);
await modal.ModalInstanceRef.CloseAsync(result);
}
else
{
Expand Down
2 changes: 1 addition & 1 deletion src/Blazored.Modal/BlazoredModalInstance.razor
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ else
<h3 class="blazored-modal-title">@Title</h3>
@if (!HideCloseButton)
{
<button type="button" class="blazored-modal-close" aria-label="close" @onclick="Cancel" @attributes="@_closeBtnAttributes">
<button type="button" class="blazored-modal-close" aria-label="close" @onclick="CancelAsync" @attributes="@_closeBtnAttributes">
<span>&times;</span>
</button>
}
Expand Down
12 changes: 6 additions & 6 deletions src/Blazored.Modal/BlazoredModalInstance.razor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,16 @@ public void SetTitle(string title)
/// <summary>
/// Closes the modal with a default Ok result />.
/// </summary>
public async Task Close()
public async Task CloseAsync()
{
await Close(ModalResult.Ok<object>(null));
await CloseAsync(ModalResult.Ok<object>(null));
}

/// <summary>
/// Closes the modal with the specified <paramref name="modalResult"/>.
/// </summary>
/// <param name="modalResult"></param>
public async Task Close(ModalResult modalResult)
public async Task CloseAsync(ModalResult modalResult)
{
// Fade out the modal, and after that actually remove it
if (Animation.Type == ModalAnimationType.FadeOut || Animation.Type == ModalAnimationType.FadeInOut)
Expand All @@ -101,9 +101,9 @@ public async Task Close(ModalResult modalResult)
/// <summary>
/// Closes the modal and returns a cancelled ModalResult.
/// </summary>
public async Task Cancel()
public async Task CancelAsync()
{
await Close(ModalResult.Cancel());
await CloseAsync(ModalResult.Cancel());
}

private void ConfigureInstance()
Expand Down Expand Up @@ -290,7 +290,7 @@ private async Task HandleBackgroundClick()
{
if (DisableBackgroundCancel) return;

await Cancel();
await CancelAsync();
}
}
}
2 changes: 1 addition & 1 deletion tests/src/Blazored.Modal.Tests/Assets/TestComponent.razor
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="test-component">
<h1>@Title</h1>
<button class="test-component__close-button" @onclick="BlazoredModal.Close">Close</button>
<button class="test-component__close-button" @onclick="BlazoredModal.CloseAsync">Close</button>
</div>

@code {
Expand Down