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

Standardise the use of Hidden and HiddenChanged #8952

Merged
merged 1 commit into from May 13, 2024

Conversation

BieleckiLtd
Copy link
Contributor

@BieleckiLtd BieleckiLtd commented May 11, 2024

MudBlazor currently uses the IsHidden and IsHiddenChanged properties. This PR aims to standardise the use of Hidden and HiddenChanged to align with other boolean properties in the library.

Description

If this PR is approved, the v7 migration guide must also be updated, as this makes a breaking change:

MudHidden: replace IsHidden with Hidden
MudHidden: replace IsHiddenChanged with HiddenChanged

Linked issues:
Negative property names should be discouraged #6131
v7.0.0 Migration Guide #8447

Standardise the use of IsEnabled and Enabled #8764
Standardise the use of ItemDisabled #8887
Standardise the use of Checked, CheckedChanged and Checkable #8825
Standardise the use of Visible #8832
Standardise the use of Selected and SelectedChanged #8886
Standardise the use of Expanded, Expandable, IsExpanded and IsExpandable #8718
Standardise the use of Active #8888
Standardise the use of Open and OpenChanged #8891
Standardise the use of Editable #8892
Standardise the use of Hidden and HiddenChanged #8952

How Has This Been Tested?

unit

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 breaking change bug Something does not work as intended/expected PR: needs review labels May 11, 2024
@BieleckiLtd
Copy link
Contributor Author

I think this is one of the rare cases where Hidden would be more appropriate than Visible because <MudHidden Visible="false"></MudHidden> would read very weirdly.

Copy link

codecov bot commented May 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.49%. Comparing base (28bc599) to head (3bf503a).
Report is 180 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #8952      +/-   ##
==========================================
+ Coverage   89.82%   90.49%   +0.66%     
==========================================
  Files         412      419       +7     
  Lines       11878    12192     +314     
  Branches     2364     2380      +16     
==========================================
+ Hits        10670    11033     +363     
+ Misses        681      627      -54     
- Partials      527      532       +5     

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

@danielchalmers
Copy link
Contributor

I think this is one of the rare cases where Hidden would be more appropriate than Visible because <MudHidden Visible="false"></MudHidden> would read very weirdly.

Don't necessarily disagree but Visible=false would be the default, right?

@henon henon merged commit 5910c9b into MudBlazor:dev May 13, 2024
5 checks passed
@henon henon mentioned this pull request May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change bug Something does not work as intended/expected
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants