Skip to content

Comments

fix: changed checkboxes to toggles on notifications settings page#6175

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
fix-notification-toggle
Dec 9, 2024
Merged

fix: changed checkboxes to toggles on notifications settings page#6175
sriramveeraghanta merged 1 commit intopreviewfrom
fix-notification-toggle

Conversation

@vihar
Copy link
Contributor

@vihar vihar commented Dec 9, 2024

Description

Updated notification settings page checkboxes to toggles for better visibility. Removed Save button for better UX, now updating a setting will automatically save notification preferences.

Type of Change

  • Improvement (change that would cause existing functionality to not work as expected)

Screenshots and Media (if applicable)

CleanShot 2024-12-10 at 00 38 01@2x

References

Fixes #6174.

Summary by CodeRabbit

  • New Features

    • Introduced a ToggleSwitch component for user notification settings, replacing the previous Checkbox.
    • Notifications settings can now be updated immediately upon toggling.
  • Bug Fixes

    • Improved handling of success and error responses with toast notifications.
  • Refactor

    • Simplified form state management by removing unnecessary submission tracking and handling.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Walkthrough

The pull request introduces significant changes to the EmailNotificationForm component by replacing the Checkbox component with a ToggleSwitch component for managing user notification settings. The form submission logic has been simplified, with the removal of the onSubmit function and the introduction of a new handleSettingChange function that updates settings directly upon toggling. The component no longer tracks submission state or dirty fields, streamlining the user experience for managing notification preferences.

Changes

File Path Change Summary
web/core/components/profile/notification/email-notification-form.tsx Replaced Checkbox with ToggleSwitch, removed onSubmit, introduced handleSettingChange, and simplified state management.

Assessment against linked issues

Objective Addressed Explanation
Improve visibility of email notification settings (#[6174])

Possibly related PRs

Suggested labels

🌐frontend, 🎨UI / UX, 🌟improvement, 🐛bug

Suggested reviewers

  • sriramveeraghanta
  • SatishGandham

Poem

In the land of toggles, bright and new,
Notifications dance, just for you.
With a switch, your choices flow,
Easy to see, now watch them glow!
A rabbit's cheer for settings so clear,
Hopping with joy, we hold them dear! 🐇✨


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. (Experiment)
  • @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.

@vihar vihar requested a review from SatishGandham December 9, 2024 19:09
Copy link
Contributor

@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: 1

🧹 Outside diff range and nitpick comments (3)
web/core/components/profile/notification/email-notification-form.tsx (3)

31-48: Consider enhancing error handling and user feedback

While the implementation is solid, consider these improvements:

  1. Add loading state handling to prevent multiple simultaneous updates
  2. Make error messages more specific by including the setting that failed to update

Here's a suggested improvement:

 const handleSettingChange = async (key: keyof IUserEmailNotificationSettings, value: boolean) => {
+  const settingName = key.replace(/_/g, ' '); // Convert key to readable form
+  const [isUpdating, setIsUpdating] = useState<boolean>(false);
+  
+  if (isUpdating) return;
+  
+  setIsUpdating(true);
   try {
     await userService.updateCurrentUserEmailNotificationSettings({
       [key]: value,
     });
     setToast({
       title: "Success!",
       type: TOAST_TYPE.SUCCESS,
-      message: "Email notification setting updated successfully",
+      message: `${settingName} setting updated successfully`,
     });
   } catch (err) {
     console.error(err);
     setToast({
       title: "Error!",
       type: TOAST_TYPE.ERROR,
-      message: "Failed to update email notification setting",
+      message: `Failed to update ${settingName} setting. Please try again.`,
     });
+  } finally {
+    setIsUpdating(false);
   }
 };

64-64: Fix grammatical error in description text

There's a minor grammatical error in the description text.

-              Notify me when issue's properties like assignees, priority, estimates or anything else changes.
+              Notify me when issue properties like assignees, priority, estimates or anything else change.

Line range hint 1-182: Overall implementation successfully meets PR objectives

The changes effectively address the visibility issues mentioned in #6174 by:

  1. Replacing checkboxes with more visible toggle switches
  2. Implementing immediate updates without requiring a Save button
  3. Maintaining clear, descriptive labels for each setting

The code is well-structured and implements the required functionality correctly.

Consider implementing optimistic updates to improve perceived performance, updating the UI immediately while the API call happens in the background.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ff8bbed and 0a2c744.

📒 Files selected for processing (1)
  • web/core/components/profile/notification/email-notification-form.tsx (7 hunks)
🔇 Additional comments (1)
web/core/components/profile/notification/email-notification-form.tsx (1)

7-7: LGTM!

The imports are correctly updated to include the new ToggleSwitch component and toast utilities.

Comment on lines +72 to +79
<ToggleSwitch
value={value}
onChange={(newValue) => {
onChange(newValue);
handleSettingChange("property_change", newValue);
}}
size="sm"
/>
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider extracting toggle switch implementation to reduce duplication

The toggle switch implementation is repeated across multiple settings. Consider creating a reusable component to reduce code duplication.

Here's a suggested approach:

interface NotificationToggleProps {
  name: keyof IUserEmailNotificationSettings;
  control: Control<IUserEmailNotificationSettings>;
  onSettingChange: (key: keyof IUserEmailNotificationSettings, value: boolean) => Promise<void>;
}

const NotificationToggle: FC<NotificationToggleProps> = ({ name, control, onSettingChange }) => (
  <Controller
    control={control}
    name={name}
    render={({ field: { value, onChange } }) => (
      <ToggleSwitch
        value={value}
        onChange={(newValue) => {
          onChange(newValue);
          onSettingChange(name, newValue);
        }}
        size="sm"
      />
    )}
  />
);

Then use it like this:

-<Controller
-  control={control}
-  name="property_change"
-  render={({ field: { value, onChange } }) => (
-    <ToggleSwitch
-      value={value}
-      onChange={(newValue) => {
-        onChange(newValue);
-        handleSettingChange("property_change", newValue);
-      }}
-      size="sm"
-    />
-  )}
-/>
+<NotificationToggle
+  name="property_change"
+  control={control}
+  onSettingChange={handleSettingChange}
+/>

Also applies to: 96-102, 118-125, 142-149, 166-173

@sriramveeraghanta sriramveeraghanta merged commit 205395e into preview Dec 9, 2024
@sriramveeraghanta sriramveeraghanta deleted the fix-notification-toggle branch December 9, 2024 19:32
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.

[bug]: Email notifications checkboxes difficult to see

2 participants