Skip to content

DialogService: Mark sync API as obsolete#10000

Merged
ScarletKuro merged 3 commits intoMudBlazor:devfrom
ScarletKuro:dialog_obs
Oct 13, 2024
Merged

DialogService: Mark sync API as obsolete#10000
ScarletKuro merged 3 commits intoMudBlazor:devfrom
ScarletKuro:dialog_obs

Conversation

@ScarletKuro
Copy link
Member

@ScarletKuro ScarletKuro commented Oct 12, 2024

Description

We should have done this a long time ago in v7, but it is what it is. It wasn't marked obsolete, so people had no idea that it would be beneficial to switch to the async versions. I'm against removing them in v8 as for now, as it would result in too many breaking changes. Many of the breaking changes in the current v8 are very minor and rare to encounter.

NB!: I also moved DialogOptions, DialogParameters, DialogParametersGeneric, DialogReference, IDialogReference to Services/Dialog because this is their logical place, They are essential for the service, and they shouldn't be placed near the components. The namespaces weren't touched.

Type of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (fix or improvement to the website or code docs)

Checklist

  • The PR is submitted to the correct branch (dev).
  • My code follows the code style of this project.
  • I've added relevant tests.

@github-actions github-actions bot added enhancement Adds a new feature or enhances existing functionality (not fixing a defect) in the main library PR: needs review labels Oct 12, 2024
@ScarletKuro ScarletKuro requested a review from henon October 12, 2024 22:20
@codecov
Copy link

codecov bot commented Oct 12, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 90.95%. Comparing base (28bc599) to head (b3807a8).
Report is 562 commits behind head on dev.

Files with missing lines Patch % Lines
src/MudBlazor/Services/Dialog/DialogService.cs 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev   #10000      +/-   ##
==========================================
+ Coverage   89.82%   90.95%   +1.12%     
==========================================
  Files         412      408       -4     
  Lines       11878    12534     +656     
  Branches     2364     2446      +82     
==========================================
+ Hits        10670    11400     +730     
+ Misses        681      579     -102     
- Partials      527      555      +28     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@henon henon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looking good. Is the sync api still in use in our docs or was it already replaced earlier?

@ScarletKuro
Copy link
Member Author

All looking good. Is the sync api still in use in our docs or was it already replaced earlier?

Everything was replaced long time ago.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Adds a new feature or enhances existing functionality (not fixing a defect) in the main library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants