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

Show missing required asterisk in BitTimePicker's label (#9893) #9894

Conversation

Cyrus-Sushiant
Copy link
Member

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

This closes #9893

Summary by CodeRabbit

  • New Features
    • Introduced a conditional "required" option to the time input component, ensuring user input when enabled.
    • Added a visual cue (asterisk) on the field label to indicate mandatory input.
    • Updated demonstration examples to showcase the new required functionality.

Copy link

coderabbitai bot commented Feb 14, 2025

Walkthrough

This update introduces a required field feature for the TimePicker component. The modifications add a new Required attribute to the <input> element, update the component’s code-behind to conditionally register a CSS class when required, and include a corresponding styling definition in the stylesheet. In addition, the demo pages are updated to showcase the new functionality by incorporating the Required parameter.

Changes

File(s) Change Summary
src/BlazorUI/…/TimePicker/BitTimePicker.razor
src/BlazorUI/…/TimePicker/BitTimePicker.razor.cs
Added a Required attribute to the input element and modified the CSS class registration to include "bit-tpc-req" when IsEnabled and Required are true.
src/BlazorUI/…/TimePicker/BitTimePicker.scss Introduced a new CSS class .bit-tpc-req that styles the label (via .bit-tpc-lbl::after) with an asterisk to indicate a required field.
src/BlazorUI/Demo/…/TimePicker/BitTimePickerDemo.razor
src/BlazorUI/Demo/…/TimePicker/BitTimePickerDemo.razor.cs
Updated the demo pages to include the Required parameter and demonstrate the TimePicker’s new required field functionality.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant T as BitTimePicker Component
    participant I as Input Element
    participant S as Stylesheet

    U->>T: Access TimePicker demo page
    T->>I: Render input with required attribute if Required is true
    T->>T: Check IsEnabled and Required properties
    T->>S: Register CSS class "bit-tpc-req" conditionally
    S-->>T: Apply asterisk styling to label
    T-->>U: Display updated TimePicker with required indicator
Loading

Poem

I'm a rabbit with code so fleet,
Hopping through changes oh so neat.
A required star now shines so bright,
Marking input paths with guiding light.
In TimePicker's realm, every detail glows,
As my little paws celebrate these flows!
🥕 Happy hops and flawless shows!


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/TimePicker/BitTimePickerDemo.razor.cs (1)

5-222: 🛠️ Refactor suggestion

Add documentation for the Required parameter.

The Required parameter is demonstrated in the example but not documented in the componentParameters list. Add the parameter documentation to maintain consistency.

         new()
         {
             Name = "Responsive",
             Type = "bool",
             DefaultValue = "false",
             Description = "Enables the responsive mode in small screens.",
         },
+        new()
+        {
+            Name = "Required",
+            Type = "bool",
+            DefaultValue = "false",
+            Description = "Whether the TimePicker input is required.",
+        },
         new()
         {
             Name = "ShowCloseButton",
             Type = "bool",
🧹 Nitpick comments (2)
src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/TimePicker/BitTimePicker.scss (1)

378-384: LGTM! Consider adding aria-required for better accessibility.

The implementation follows the project's styling patterns and uses consistent spacing and color variables. The required field indicator is visually clear and well-positioned.

While the visual indicator is good, ensure that the corresponding HTML template includes aria-required="true" on the input element for better accessibility. This complements the visual asterisk with proper semantic meaning for screen readers.

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

592-592: LGTM! Consider enhancing the example with a placeholder.

The example effectively demonstrates the Required parameter. To make it more consistent with other examples and improve user experience, consider adding a placeholder text.

-<BitTimePicker Label="Required" Required />
+<BitTimePicker Label="Required" Required Placeholder="Select a time..." />
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 94fcdd9 and a52108b.

📒 Files selected for processing (5)
  • src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/TimePicker/BitTimePicker.razor (1 hunks)
  • src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/TimePicker/BitTimePicker.razor.cs (1 hunks)
  • src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/TimePicker/BitTimePicker.scss (1 hunks)
  • src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/TimePicker/BitTimePickerDemo.razor (1 hunks)
  • src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/TimePicker/BitTimePickerDemo.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/TimePicker/BitTimePicker.razor (1)

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

The required attribute is correctly bound to the Required property, enabling HTML5 form validation when needed.

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/TimePicker/BitTimePicker.razor.cs (1)

319-319: LGTM! The required CSS class is properly registered.

The CSS class registration correctly considers both IsEnabled and Required states, following the component's naming conventions.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/TimePicker/BitTimePickerDemo.razor (2)

21-21: LGTM! The required TimePicker example is well placed.

The example clearly demonstrates how to use the Required feature in a simple and understandable way.


592-592: LGTM! The example code is properly updated.

The example code accurately reflects the implementation and maintains consistent formatting.

@msynk msynk merged commit 903c4a0 into bitfoundation:develop Feb 15, 2025
3 checks passed
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 BitTimePicker
2 participants