Skip to content

Show missing required asterisk in BitDateRangePicker's label (#9888)#9889

Merged
msynk merged 1 commit intobitfoundation:developfrom
Cyrus-Sushiant:9888-fix-required-issue-bitdaterangepicker
Feb 13, 2025
Merged

Show missing required asterisk in BitDateRangePicker's label (#9888)#9889
msynk merged 1 commit intobitfoundation:developfrom
Cyrus-Sushiant:9888-fix-required-issue-bitdaterangepicker

Conversation

@Cyrus-Sushiant
Copy link
Member

@Cyrus-Sushiant Cyrus-Sushiant commented Feb 13, 2025

This closes #9888

Summary by CodeRabbit

  • New Features
    • The date range picker now enforces input validation by marking fields as mandatory, ensuring users provide a date before submitting a form.
    • A demo instance now illustrates the required behavior.
  • Style
    • Added visual cues for required fields by displaying an asterisk next to the label, enhancing the overall user experience.

@coderabbitai
Copy link

coderabbitai bot commented Feb 13, 2025

Walkthrough

The changes introduce a new Required attribute for the date range picker component. In the Razor file, the <input> element is updated with required="@Required", while the code-behind registers a new CSS class "bit-dtrp-req" when the component is enabled and required. A corresponding SCSS rule is added to style the required indicator with an asterisk. Additionally, demo pages are updated to showcase the required functionality in the date range picker examples.

Changes

File(s) Change Summary
src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.razor Added required="@Required" attribute to the <input> element.
src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.razor.cs Modified RegisterCssClasses to include "bit-dtrp-req" when IsEnabled and Required are true.
src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.scss Added new CSS class .bit-dtrp-req with nested styling for a label asterisk.
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/DateRangePicker/... Updated demo Razor and code-behind files to include usage of the Required attribute in the component.

Sequence Diagram(s)

sequenceDiagram
    participant Demo as Demo Page
    participant DTP as BitDateRangePicker
    participant CSS as Stylesheet
    
    Demo->>DTP: Render component with Required attribute
    DTP->>DTP: Set <input> with required="@Required"
    DTP->>DTP: Call RegisterCssClasses()
    Note right of DTP: If Enabled & Required, add "bit-dtrp-req"
    DTP->>CSS: Apply .bit-dtrp-req styles
    CSS-->>DTP: Render asterisk indicator on label
Loading

Poem

I'm a rabbit with code so spry,
Hopping through changes under the sky.
A required field now shines so bright,
With CSS magic, it’s a lovely sight.
In every line, a new twist I see,
Cheering for clarity and harmony!
🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🔭 Outside diff range comments (1)
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/DateRangePicker/BitDateRangePickerDemo.razor.cs (1)

5-431: 🛠️ Refactor suggestion

Add documentation for the Required property.

The Required property should be documented in the component parameters list to maintain consistency with other parameters and provide clear documentation for users.

Add the following parameter documentation:

 private readonly List<ComponentParameter> componentParameters = new()
 {
+    new()
+    {
+        Name = "Required",
+        Type = "bool",
+        DefaultValue = "false",
+        Description = "Whether the DateRangePicker is required to have a value.",
+    },
     new()
     {
         Name = "AllowTextInput",
         Type = "bool",
🧹 Nitpick comments (1)
src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.scss (1)

794-800: LGTM! Consider enhancing accessibility.

The required field styling is well-implemented, following the codebase patterns and properly handling RTL layouts.

Consider adding aria-hidden="true" to the asterisk to prevent screen readers from announcing it, while ensuring the required state is communicated through ARIA attributes on the input element:

 .bit-dtrp-req {
     .bit-dtrp-lbl::after {
-        content: "*";
+        content: "*" / "";  /* The empty string after the slash will be used for aria-label */
         color: $clr-req;
         margin-inline-start: spacing(0.625);
     }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc729eb and 79285d6.

📒 Files selected for processing (5)
  • src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.razor (1 hunks)
  • src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.razor.cs (1 hunks)
  • src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.scss (1 hunks)
  • src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/DateRangePicker/BitDateRangePickerDemo.razor (1 hunks)
  • src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/DateRangePicker/BitDateRangePickerDemo.razor.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build and test
🔇 Additional comments (4)
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/DateRangePicker/BitDateRangePickerDemo.razor (1)

22-23: LGTM! Good example of required field usage.

The example clearly demonstrates how to use the new required field functionality.

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.razor (1)

36-36: LGTM! Proper implementation of HTML5 required attribute.

The required attribute is correctly bound to the Required property, enabling native form validation.

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.razor.cs (1)

568-568: LGTM! Well-implemented CSS class registration.

The CSS class registration correctly handles both enabled and required states, following the component's established patterns.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/DateRangePicker/BitDateRangePickerDemo.razor.cs (1)

1012-1012: LGTM! The example demonstrates the Required property effectively.

The example is well-placed within the basic examples section and follows the same pattern as other examples, making it easy for users to understand how to use the Required property.

@msynk msynk merged commit 1f18d76 into bitfoundation:develop Feb 13, 2025
3 checks passed
@Cyrus-Sushiant Cyrus-Sushiant deleted the 9888-fix-required-issue-bitdaterangepicker branch March 22, 2025 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing Required asterisk in BitDateRangePicker

2 participants