feat: add `defaultMode` to `DarkMode` component

[ttytm]

📑 Description

Adds the ability to specify a defaultMode.

I was missing the easy ability to set a default mode for first-time-visitors. As a reference: I was used to working with the package mode-watcher, it allows to set a default mode.

It makes workaround-overrides/boilerplate like below obsolete:

onMount(() => {
	if (!('color-theme' in localStorage)) {
		document.documentElement.classList.remove('dark');
	}
});

With the changes one could just:

<DarkMode defaultMode="light">

Status

• [x] Not Completed
• [ ] Completed

The PR is mostly but not fully finished. Please let me know if completing the PR has a chance for a merge @shinokada. Sorry about this approach, I'm trying to balance things due to time constraints.

✅ Checks

• [x] My pull request adheres to the code style of this project
• [x] My code requires changes to the documentation
• [ ] I have updated the documentation as required
• [ ] I have checked the page with https://validator.unl.edu/
• [ ] All the tests have passed
• [x] My pull request is based on the latest commit (not the npm version).

ℹ Additional Information

[vercel[bot]]

@ttytm is attempting to deploy a commit to the Themesberg Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai[bot]]

Walkthrough

A new exported variable defaultMode has been introduced in the DarkMode.svelte file, allowing the setting of an initial dark or light mode. If this variable is set to 'dark', the dark mode is automatically applied.

Changes

File Path	Change Summary
src/lib/darkmode/DarkMode.svelte	Added defaultMode variable to control initial mode setting.

Poem

In the realm of light and dark, A switch now makes its mark, With defaultMode so clear and bright, Choose your shade, day or night. A simple line, a thoughtful spark, Illuminates both light and dark. 🌞🌜

---

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>.
  • 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.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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.

[shinokada]

You can set the initial theme.

[ttytm]

Thanks for the response.

Checking the code, the module adds the dark class on it's own:

https://github.com/themesberg/flowbite-svelte/blob/8c2e834d4d2981625074236b83525f576c487461/src/lib/darkmode/DarkMode.svelte#L30

So as far as I can see test: the suggestion doesn't fully work. It's not possible to set a dedicated default light mode. Because if the browser is set to dark mode it will use dark as default, even when class="dark" is not explicitly set.

This means the default mode is not light as the documentation states, but it is based on the browser setting. But the goal is to allow to set a default mode explicitly and fall back to the browser setting if no default mode is passed.

For a reproduction: open a site where class="dark" is NOT added with a browser using a dark theme setting. Then dark is used as default theme (when doing so make sure a clean state, like localStorage doesn't have a theme saved).

[ttytm]

What I want to add: My personal preference on a website is to have the mode detected and set to dark if there is a dark setting. So in regards to this the current behavior is good.

Though this PR isn't about personal preference, it comes from working on a project whose default mode should explicitly be light. And I think this possibility should be provided.

When you find a free moment, can you please investigate if the behavior is correct based on my previous comment https://github.com/themesberg/flowbite-svelte/pull/1384#issuecomment-2218077494, @shinokada?

[vercel[bot]]

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

Name	Status	Preview	Comments	Updated (UTC)
flowbite-svelte	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 21, 2024 5:05pm

[shinokada]

DarkMode has unused export property 'defaultMode'. If it is for external reference only, please consider using export const defaultMode

[ttytm]

Thanks for the review. I'm gonna update accordingly soon.