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

FreakySwitch: Added customization options for animation duration, thumb size in the… #165

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sferhah
Copy link

@sferhah sferhah commented Jan 9, 2025

Added customization options for: animation duration, thumb size in the off state, and a check mark in the on state. Example of use:

<freaky:FreakySwitch AnimationDuration="30" 
                         ThumbOffSizeFactor="0.67"                         
                         ShowCheckMark="True"
                         CheckMarkWidth="3"
                         CheckMarkColor="Purple"/>

Summary by CodeRabbit

  • New Features

    • Enhanced FreakySwitch control with customizable animation duration
    • Added optional checkmark display for switch state
    • Introduced new configuration properties for thumb size and appearance
  • Improvements

    • More flexible switch control with advanced visual customization options
    • Dynamic animation timing for smoother state transitions

… off state, and a check mark in the on state.
Copy link

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request introduces significant enhancements to the FreakySwitch control in the MAUI.FreakyControls library. The modifications focus on improving the switch's customization capabilities by adding new properties that control animation duration, thumb sizing, and the ability to display a checkmark. The changes provide more flexibility in visual presentation and behavior, allowing developers to fine-tune the switch's appearance and interaction through new bindable properties.

Changes

File Change Summary
MAUI.FreakyControls/...FreakySwitch.cs - Added new properties: AnimationDuration, ThumbOffSizeFactor, ShowCheckMark, CheckMarkWidth, CheckMarkColor
- Introduced corresponding bindable properties
- Updated AnimateThumbAsync method to use dynamic animation duration
- Enhanced DrawOnState to include optional checkmark rendering
- Modified DrawOffState thumb sizing logic

Sequence Diagram

sequenceDiagram
    participant Developer
    participant FreakySwitch
    participant Renderer

    Developer->>FreakySwitch: Set custom properties
    FreakySwitch->>Renderer: Configure animation duration
    FreakySwitch->>Renderer: Adjust thumb size
    FreakySwitch->>Renderer: Render checkmark (optional)
    Renderer-->>Developer: Updated switch control
Loading

Poem

🐰 A switch so freaky and bright,
With checkmarks dancing left and right!
Animation smooth, thumb sizing neat,
Customization now complete!
Hop along, control so fine! 🎉

Finishing Touches

  • 📝 Generate Docstrings

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

🧹 Nitpick comments (3)
MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs (3)

54-58: Consider improving the animation duration validation.

While the safety check for non-positive values is good, consider:

  1. Setting a reasonable minimum duration (e.g., 16ms for 60fps) for smooth animations
  2. Adding an upper bound to prevent extremely long animations
-        if (durationInSeconds <= 0)
-        {
-            durationInSeconds = 0.001d;
-        }
+        const double MIN_DURATION_SECONDS = 0.016; // 16ms minimum for 60fps
+        const double MAX_DURATION_SECONDS = 1.0; // 1 second maximum
+        durationInSeconds = Math.Clamp(durationInSeconds, MIN_DURATION_SECONDS, MAX_DURATION_SECONDS);

189-205: LGTM! Well-implemented check mark drawing with proper scaling.

The check mark is correctly positioned relative to the thumb size, ensuring proper scaling across different switch sizes.

Add parentheses to clarify arithmetic precedence.

To improve code clarity, add parentheses around arithmetic expressions.

-            checkmarkPath.MoveTo(thumbLeft + thumbWidth * 0.25f, thumbTop + thumbWidth * 0.5f);
-            checkmarkPath.LineTo(thumbLeft + thumbWidth * 0.45f, thumbTop + thumbWidth * 0.7f);
-            checkmarkPath.LineTo(thumbLeft + thumbWidth * 0.75f, thumbTop + thumbWidth * 0.3f);
+            checkmarkPath.MoveTo(thumbLeft + (thumbWidth * 0.25f), thumbTop + (thumbWidth * 0.5f));
+            checkmarkPath.LineTo(thumbLeft + (thumbWidth * 0.45f), thumbTop + (thumbWidth * 0.7f));
+            checkmarkPath.LineTo(thumbLeft + (thumbWidth * 0.75f), thumbTop + (thumbWidth * 0.3f));
🧰 Tools
🪛 GitHub Check: CodeFactor

[notice] 193-193: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L193
Arithmetic expressions should declare precedence. (SA1407)


[notice] 195-195: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L195
Arithmetic expressions should declare precedence. (SA1407)


[notice] 194-194: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L194
Arithmetic expressions should declare precedence. (SA1407)


[notice] 193-193: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L193
Arithmetic expressions should declare precedence. (SA1407)


[notice] 194-194: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L194
Arithmetic expressions should declare precedence. (SA1407)


[notice] 195-195: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L195
Arithmetic expressions should declare precedence. (SA1407)


Line range hint 226-233: Consider tightening the thumb size factor validation.

While the current validation ensures the factor is between 0 and 1, consider:

  1. Excluding 0 as it would make the thumb invisible
  2. Setting a minimum size factor (e.g., 0.2) to maintain usability
-        if (ThumbOffSizeFactor > 0 && ThumbOffSizeFactor < 1)
+        const float MIN_THUMB_SIZE_FACTOR = 0.2f;
+        if (ThumbOffSizeFactor >= MIN_THUMB_SIZE_FACTOR && ThumbOffSizeFactor < 1)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 97d49d3 and 8496faa.

📒 Files selected for processing (1)
  • MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs (8 hunks)
🧰 Additional context used
🪛 GitHub Check: CodeFactor
MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs

[notice] 193-193: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L193
Arithmetic expressions should declare precedence. (SA1407)


[notice] 195-195: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L195
Arithmetic expressions should declare precedence. (SA1407)


[notice] 194-194: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L194
Arithmetic expressions should declare precedence. (SA1407)


[notice] 193-193: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L193
Arithmetic expressions should declare precedence. (SA1407)


[notice] 194-194: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L194
Arithmetic expressions should declare precedence. (SA1407)


[notice] 195-195: MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs#L195
Arithmetic expressions should declare precedence. (SA1407)

🔇 Additional comments (2)
MAUI.FreakyControls/MAUI.FreakyControls/FreakySwitch/FreakySwitch.cs (2)

17-21: LGTM! Well-chosen default values for the new customization options.

The default values are sensible and maintain platform-specific behavior where appropriate.


Line range hint 255-381: LGTM! Well-implemented bindable properties following MAUI conventions.

The new properties are correctly implemented with appropriate types and default values, maintaining consistency with the static fields.

@sferhah sferhah changed the title Added customization options for animation duration, thumb size in the… FreakySwitch: Added customization options for animation duration, thumb size in the… Jan 9, 2025
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.

1 participant