Show missing required asterisk in BitCircularTimePicker's label (#9890)

[Cyrus-Sushiant]

This closes #9890

Summary by CodeRabbit

• New Features

  • The time picker now enforces a required selection, ensuring users provide input before submitting forms.
  • Demo examples have been updated to showcase this enhanced validation, including improved feedback on form submissions.

• Style

  • A new visual indicator (an asterisk styled with a distinctive color) clearly marks fields as required, enhancing the overall user interface.

[coderabbitai]

Walkthrough

The pull request adds a new Required property to the BitCircularTimePicker component. The changes include inserting a required attribute into the input element, updating the CSS class registration to conditionally include a required styling class, and adding new styles to indicate a required field with an asterisk. Additionally, the demo project has been updated to showcase the new functionality, including a delayed handling of form submission.

Changes

Files Changed	Change Summary
src/BlazorUI/.../BitCircularTimePicker.razor, .../BitCircularTimePicker.razor.cs, .../BitCircularTimePicker.scss	- Added a new Required property. - Inserted the required="@Required" attribute in the <input> element. - Updated CSS registration to conditionally apply "bit-ctp-req" based on IsEnabled and Required. - Introduced the .bit-ctp-req CSS class to style required fields using an asterisk.
src/BlazorUI/.../BitCircularTimePickerDemo.razor, .../BitCircularTimePickerDemo.razor.cs	- Integrated the new Required attribute in a demo instance of BitCircularTimePicker. - Modified the form submission handler (HandleValidSubmit) to include a delay simulating processing time.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant CTP as BitCircularTimePicker
    participant CS as ClassBuilder
    participant FH as Form Handler

    U->>CTP: Interact with time picker
    Note right of CTP: Input renders with "required" attribute if Required is true
    CTP->>CS: Register CSS class ("bit-ctp-req") if IsEnabled and Required
    U->>FH: Submit form
    FH->>CTP: Validate input (HTML5 required check)
    Note right of FH: Introduces a delay to simulate processing
    FH->>U: Return submission success

Loading

Poem

I hopped through lines of code so fine,
Adding a twist with a required sign.
Asterisk shines like a star so bright,
Valid fields dance in the light.
My rabbit heart hops with glee—
For changes that set our forms free!
🐰💻 Keep on coding, one hop at a time!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🔭 Outside diff range comments (1)

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/CircularTimePicker/BitCircularTimePickerDemo.razor (1)

5-222: 🛠️ Refactor suggestion

Add Required property to the component parameters documentation.

The Required property should be documented in the componentParameters list to maintain comprehensive API documentation.

Add this entry to the componentParameters list:

 private readonly List<ComponentParameter> componentParameters =
 [
+    new()
+    {
+        Name = "Required",
+        Type = "bool",
+        DefaultValue = "false",
+        Description = "Whether the TimePicker is required and displays an asterisk in the label.",
+    },
     // ... existing parameters
 ];

🧹 Nitpick comments (1)

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/CircularTimePicker/BitCircularTimePicker.scss (1)

393-399: LGTM! Consider adding RTL support.

The implementation follows the component's styling patterns and properly uses design tokens for color and spacing. The asterisk is appropriately implemented using a pseudo-element.

Consider adding RTL support by using margin-inline-start instead of margin-left:

 .bit-ctp-req {
     .bit-ctp-lbl::after {
         content: "*";
         color: $clr-req;
-        margin-left: spacing(0.625);
+        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 1f18d76 and 3ae11cc.

📒 Files selected for processing (5)

• src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/CircularTimePicker/BitCircularTimePicker.razor (1 hunks)
• src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/CircularTimePicker/BitCircularTimePicker.razor.cs (1 hunks)
• src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/CircularTimePicker/BitCircularTimePicker.scss (1 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/CircularTimePicker/BitCircularTimePickerDemo.razor (1 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/CircularTimePicker/BitCircularTimePickerDemo.razor.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build and test

🔇 Additional comments (4)

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/CircularTimePicker/BitCircularTimePicker.razor (1)

36-36: LGTM! The required attribute is correctly implemented.

The required attribute is properly bound to the Required property, which will enforce HTML5 validation when the property is true.

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/CircularTimePicker/BitCircularTimePicker.razor.cs (1)

282-282: LGTM! The CSS class registration is well implemented.

The class registration correctly considers both IsEnabled and Required states, following the component's established patterns.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/CircularTimePicker/BitCircularTimePickerDemo.razor (1)

22-22: LGTM! The Required property is demonstrated effectively.

The example clearly shows how to use the new Required property.

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

560-566: LGTM! The form submission handling is improved.

The addition of a delay provides better user feedback by showing the success message for 3 seconds before clearing it.