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

Updated theme mode 'auto' to remove storage integration #1400

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

lancegliser
Copy link

@lancegliser lancegliser commented May 23, 2024

Summarize the changes made and the motivation behind them.

  • Updated the set mode functionality to ignore and remove storage items when set to auto.
  • Added a debounce to set mode (which we should debate as it might break automated tests)

Reference related issues using # followed by the issue number.

#1352

Copy link

changeset-bot bot commented May 23, 2024

⚠️ No Changeset found

Latest commit: e5fde61

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented May 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flowbite-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2024 2:17pm
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2024 2:17pm

Copy link
Contributor

coderabbitai bot commented May 23, 2024

Walkthrough

The changes introduce a debounce mechanism to the use-theme-mode hook to improve performance by reducing the frequency of function calls. The handleSetMode function was renamed and wrapped with a debounce function to delay its execution by 25 milliseconds. Additionally, the setModeInLS function was updated to handle the "auto" mode by removing the local storage value if it exists.

Changes

File Path Change Summary
packages/ui/src/hooks/use-theme-mode.ts - Added import debounce from "debounce"; for debouncing functionality.
- Renamed handleSetMode to _handleSetMode and debounced it with 25ms delay.
- Updated setModeInLS to handle "auto" mode by removing the local storage value.

🌼 In the code where themes do sway,
🌙 A debounce comes to save the day.
With functions timed, and storage clear,
Our UI shines, no need to fear.
🐇 Hopping through the code we go,
Making it smooth, like a rabbit's flow.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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
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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between b2640bc and e5fde61.
Files selected for processing (1)
  • packages/ui/src/hooks/use-theme-mode.ts (4 hunks)
Additional comments not posted (4)
packages/ui/src/hooks/use-theme-mode.ts (4)

3-3: The import and application of debounce to handleSetMode are correctly implemented.

Also applies to: 50-50


44-44: Renaming handleSetMode to _handleSetMode and its implementation are correctly handled.


136-136: The implementation of prefersColorScheme to determine the browser's preferred color scheme is correct.


Line range hint 3-136: The overall structure and consistency of the file are maintained well.

packages/ui/src/hooks/use-theme-mode.ts Show resolved Hide resolved
*/
const setModeInLS = (mode: ThemeMode) => localStorage.setItem(LS_THEME_MODE, mode);
const setModeInLS = (mode: ThemeMode) => {
if (mode === "auto") {
Copy link
Collaborator

Choose a reason for hiding this comment

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

this will break the current logic, auto value is meant to be saved in LS and from that computed to either light or dark

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.

2 participants