docs(readme): fix theme storageKey to match app default#194
Open
andrerfneves wants to merge 1 commit into
Open
docs(readme): fix theme storageKey to match app default#194andrerfneves wants to merge 1 commit into
andrerfneves wants to merge 1 commit into
Conversation
The Theming section code example in the README showed `storageKey="ui-theme"` but the app's `main.tsx` uses `storageKey="lightning-decoder-theme"`. A developer copying the example verbatim would get a different theme key than the application's actual default, causing theme preferences to not sync with the running app. Also keeps the example aligned with PR #191 which fixed the `@/` import path in the same code block.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the README Theming section's code example which showed
storageKey="ui-theme"while the actual app inmain.tsxusesstorageKey="lightning-decoder-theme".Why
The README code example was inconsistent with the actual application code. A developer copying the example into their own project would get a different theme storage key than the app's default, causing theme preferences to not sync correctly.
Changes
README.md: ChangedstorageKey="ui-theme"tostorageKey="lightning-decoder-theme"in the Theming section code example, matching the actual value used inmain.tsxTest Plan
main.tsx