Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 21, 2025

add FirstDayOfWeek parameter

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5414

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

This pull request introduces a new FirstDayOfWeek parameter to the DateTimePicker component, allowing users to customize the first day of the week in the calendar. The implementation includes modifications to the DatePickerBody component to handle the new parameter and a unit test to ensure the functionality works as expected.

New Features:

  • Added a FirstDayOfWeek parameter to the DateTimePicker component to allow users to configure the first day of the week displayed in the calendar.

Enhancements:

  • The week list is now dynamically generated based on the FirstDayOfWeek parameter.

Tests:

  • Added a unit test to verify the FirstDayOfWeek parameter functionality.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 21, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new FirstDayOfWeek parameter to the DateTimePicker and DatePickerBody components, allowing users to customize the first day of the week displayed in the date picker. A unit test was also added to verify the functionality of the new parameter.

Updated class diagram for DatePickerBody

classDiagram
  class DatePickerBody {
    DateTime StartDate
    bool EnableDisabledDaysCache
    DayOfWeek FirstDayOfWeek
    List<string> WeekLists
    +OnParametersSet()
    +ShouldRender()
    -GetWeekList()
  }
  note for DatePickerBody "Added FirstDayOfWeek property and GetWeekList method"
Loading

Updated class diagram for DateTimePicker

classDiagram
  class DateTimePicker {
    string? Format
    string? TimeFormat
    DayOfWeek FirstDayOfWeek
  }
  note for DateTimePicker "Added FirstDayOfWeek property"
Loading

File-Level Changes

Change Details Files
Added a new FirstDayOfWeek parameter to the DatePickerBody component to allow users to customize the first day of the week displayed in the date picker.
  • Added a FirstDayOfWeek parameter with a default value of DayOfWeek.Sunday.
  • Modified the StartDate property to calculate the start date based on the FirstDayOfWeek parameter.
  • Modified the GetWeekList method to reorder the week list based on the FirstDayOfWeek parameter.
  • Updated OnParametersSetAsync to set _render to false before updating the disabled days cache and then setting it back to true after the update.
  • Added a ShouldRender method to control rendering based on the _render flag.
src/BootstrapBlazor/Components/DateTimePicker/DatePickerBody.razor.cs
Added a new FirstDayOfWeek parameter to the DateTimePicker component and passed it to the DatePickerBody component.
  • Added a FirstDayOfWeek parameter with a default value of DayOfWeek.Sunday.
  • Passed the FirstDayOfWeek parameter to the DatePickerBody component.
src/BootstrapBlazor/Components/DateTimePicker/DateTimePicker.razor.cs
src/BootstrapBlazor/Components/DateTimePicker/DateTimePicker.razor
Added a unit test for the FirstDayOfWeek parameter in the DateTimePicker component.
  • Added a new test method FirstDayOfWeek_Ok to verify the functionality of the FirstDayOfWeek parameter.
test/UnitTest/Components/DateTimePickerTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5414 Add a FirstDayOfWeek parameter to the DateTimePicker component to allow users to configure the first day of the week displayed in the calendar.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 21, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 21, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a globalization test to ensure the FirstDayOfWeek parameter works correctly across different cultures.
  • The code introduces a new parameter FirstDayOfWeek; ensure it's documented in the component's documentation page.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Feb 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1a219dc) to head (a281218).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5417   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29350     29359    +9     
  Branches      4129      4128    -1     
=========================================
+ Hits         29350     29359    +9     

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

@ArgoZhang ArgoZhang merged commit fd49fa0 into main Feb 21, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-datetimepicker branch February 21, 2025 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(DateTimePicker): add FirstDayOfWeek parameter

2 participants