Skip to content

feat(ThemeProvider): keep auto value#8068

Merged
ArgoZhang merged 4 commits into
mainfrom
refactor-utility
May 30, 2026
Merged

feat(ThemeProvider): keep auto value#8068
ArgoZhang merged 4 commits into
mainfrom
refactor-utility

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented May 30, 2026

Link issues

fixes #8063

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Preserve the explicit 'auto' theme value when reading and applying the current theme, aligning ThemeProvider behavior with automatic light/dark detection.

Enhancements:

  • Adjust theme retrieval to return 'auto' when no theme is set instead of resolving it to a concrete theme.
  • Update theme application logic to always delegate 'auto' to automatic light/dark resolution via the existing helper.

Copilot AI review requested due to automatic review settings May 30, 2026 00:42
@bb-auto bb-auto Bot added the bug Something isn't working label May 30, 2026
@bb-auto bb-auto Bot added this to the v10.6.0 milestone May 30, 2026
@ArgoZhang ArgoZhang merged commit 86babcf into main May 30, 2026
3 of 4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-utility branch May 30, 2026 00:43
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 30, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adjusts theme handling so that the ThemeProvider preserves the explicit 'auto' selection and centralizes the auto-theme resolution in getAutoThemeValue, rather than eagerly converting 'auto' to a concrete theme in getTheme.

Sequence diagram for updated auto theme handling

sequenceDiagram
    actor User
    participant ThemeProvider
    participant utility_js as utility
    participant Document

    User->>ThemeProvider: selectTheme(auto)
    ThemeProvider->>utility_js: setTheme(auto, sync)
    alt theme is auto
        utility_js->>utility_js: getAutoThemeValue()
        utility_js->>Document: setAttribute(data-bs-theme, getAutoThemeValue)
    else theme is explicit
        utility_js->>Document: setAttribute(data-bs-theme, theme)
    end

    Note over ThemeProvider,utility_js: getTheme now returns 'auto' when stored value is null
    User->>ThemeProvider: getCurrentTheme()
    ThemeProvider->>utility_js: getTheme(useLocalstorage)
    utility_js-->>ThemeProvider: theme or auto
Loading

File-Level Changes

Change Details Files
Preserve 'auto' as a valid theme value instead of resolving it immediately, and delegate auto-theme resolution to setTheme via getAutoThemeValue.
  • Changed getTheme to return 'auto' when no theme attribute is set or when the stored theme is null, instead of resolving it to a concrete theme value.
  • Updated setTheme so that when theme is 'auto', it always uses getAutoThemeValue() to compute and assign the actual data-bs-theme value, rather than inlining the prefers-color-scheme: dark check.
  • Kept getAutoThemeValue as the single source of truth for deriving the concrete theme when in auto mode.
src/BootstrapBlazor/wwwroot/modules/utility.js

Assessment against linked issues

Issue Objective Addressed Explanation
#8063 Ensure that when the user selects the "auto" theme, the string "auto" is persisted to and read from storage (localStorage / data attribute) instead of being converted to "dark" or "light" for storage.
#8063 On page load and theme changes, resolve the "auto" value to the actual theme (dark/light) only for DOM rendering, while still allowing system dark mode preference changes to be respected.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (82a673e) to head (1e604c1).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #8068   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          766       766           
  Lines        34155     34155           
  Branches      4697      4697           
=========================================
  Hits         34155     34155           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(ThemeProvider): 'auto' theme value is overridden with actual dark/light value

2 participants