Skip to content

Followup: news-button: blue-glow; simpler localStorage#1431

Merged
scottanderson merged 2 commits intoopenfrontio:mainfrom
floriankilian:fix-news-button-notification
Jul 14, 2025
Merged

Followup: news-button: blue-glow; simpler localStorage#1431
scottanderson merged 2 commits intoopenfrontio:mainfrom
floriankilian:fix-news-button-notification

Conversation

@floriankilian
Copy link
Contributor

@floriankilian floriankilian commented Jul 14, 2025

Description:

Changed the localStorage key from "news-button-last-seen-version" to a simpler "version" in the NewsButton component.
And reverting a coderabbit recommendation in the css file, that eliminated the blue glow effect.

Follow-up to #1385

Screenshot 2025-07-14 205018

Please complete the following:

  • I have added screenshots for all UI updates
  • I process any text displayed to the user through translateText() and I've added it to the en.json file
  • I have added relevant tests to the test directory
  • I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced
  • I understand that submitting code with bugs that could have been caught through manual testing blocks releases and new features for all contributors

Please put your Discord username so you can be contacted if a bug or regression is found:

[UN]nvm

Reverts a CodeRabbit recommendation that removed the dot (class selector) before 'news-button' in the CSS.
The removal caused styles not to be applied correctly. This change restores the original selector to
ensure consistent styling across browsers and correct application of the intended rules.
Changed the localStorage key from "news-button-last-seen-version" to a simpler "version" in the NewsButton component. This change streamlines code and aligns with naming conventions, making it easier to manage and understand. No functional alteration to how version tracking operates.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 14, 2025

Walkthrough

The changes update the localStorage key for version tracking in the NewsButton component and adjust a CSS selector to use a tag name instead of a class. No logic, control flow, or exported/public API signatures are altered.

Changes

File(s) Summary
src/client/components/NewsButton.ts Changed localStorage key from "news-button-last-seen-version" to "version" for version checks.
src/client/styles.css Modified CSS selector from .news-button .active button to news-button .active button.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NewsButton
    participant localStorage

    User->>NewsButton: Loads component
    NewsButton->>localStorage: Get "version"
    NewsButton-->>User: Show active if version mismatch

    User->>NewsButton: Clicks button
    NewsButton->>localStorage: Set "version" to current
    NewsButton-->>User: Update button state
Loading

Possibly related PRs

Suggested labels

UI/UX

Suggested reviewers

  • evanpelle

Poem

A version key, so small, so neat,
Now simply "version"—isn't that sweet?
The NewsButton shines with a CSS tweak,
Tag or class, it’s style we seek.
Change marches on, both bold and terse,
In code and rhyme, the universe!
✨📰

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-14T18_50_25_894Z-debug-0.log


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 29b587c and d78fc84.

📒 Files selected for processing (2)
  • src/client/components/NewsButton.ts (2 hunks)
  • src/client/styles.css (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: andrewNiziolek
PR: openfrontio/OpenFrontIO#1007
File: resources/lang/de.json:115-115
Timestamp: 2025-06-02T14:27:37.609Z
Learning: For OpenFrontIO project: When localization keys are renamed in language JSON files, the maintainers separate technical changes from translation content updates. They wait for community translators to update the actual translation values rather than attempting to translate in the same PR. This allows technical changes to proceed while ensuring accurate translations from native speakers.
src/client/styles.css (1)
Learnt from: its-sii
PR: openfrontio/OpenFrontIO#1089
File: src/client/styles/components/setting.css:9-22
Timestamp: 2025-06-07T19:47:34.514Z
Learning: In src/client/styles/components/setting.css, the padding difference between .setting-item and .setting-item-group is intentional - .setting-item-group doesn't need padding for the specific grouped setting styling being implemented.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: 🏗️ Build
🔇 Additional comments (3)
src/client/styles.css (1)

634-634: Good fix! CSS selector now correctly targets the custom element.

The change from .news-button (class selector) to news-button (tag selector) is correct since the component is registered as a custom element with tag name news-button. This ensures the styles apply properly to the <news-button> element.

src/client/components/NewsButton.ts (2)

29-29: Consistent with the getItem change above.

The localStorage key change maintains consistency with the getter method.


20-20: No conflicts with generic localStorage key "version"

A search across all .ts and .js files shows "version" is only used here in src/client/components/NewsButton.ts. Renaming the key is safe with respect to naming collisions.

Note: changing the key will reset existing user state—users who dismissed the notification before will see it again.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@floriankilian floriankilian marked this pull request as ready for review July 14, 2025 18:53
@floriankilian floriankilian requested a review from a team as a code owner July 14, 2025 18:53
@floriankilian floriankilian requested a review from evanpelle July 14, 2025 18:53
@floriankilian floriankilian changed the title Followup: news-button Followup: news-button: blue-glow; simpler localStorage Jul 14, 2025
@scottanderson scottanderson modified the milestones: v25, v24 Jul 14, 2025
@scottanderson scottanderson added Bug UI/UX UI/UX changes including assets, menus, QoL, etc. labels Jul 14, 2025
@github-project-automation github-project-automation bot moved this from Triage to Final Review in OpenFront Release Management Jul 14, 2025
@scottanderson scottanderson merged commit 211c2ff into openfrontio:main Jul 14, 2025
14 of 19 checks passed
@github-project-automation github-project-automation bot moved this from Final Review to Complete in OpenFront Release Management Jul 14, 2025
@floriankilian floriankilian deleted the fix-news-button-notification branch August 1, 2025 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug UI/UX UI/UX changes including assets, menus, QoL, etc.

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

2 participants