feat(hooks): Add useLocalStorage hook and documentation #109
Conversation
This file contains 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
|
🚀 Deployed Storybook Preview: http://konveyor-lib-ui-pr-109-preview.surge.sh ✨ |
Codecov Report
@@ Coverage Diff @@
## main #109 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 19 19
Branches 5 5
=========================================
Hits 19 19 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
mturley
force-pushed
the
use-local-storage
branch
from
6e99595
to
f178535
Compare
|
🎉 This PR is included in version 8.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds the
useLocalStoragehook, based on the implementation in crane-ui-plugin here, which is itself a simplification of theLocalStorageContextfrom forklift-ui here.It has been enhanced since the crane-ui-plugin version to use
JSON.stringify()and TypeScript generics so that any JSON-serializable value can be persistent instead of just strings. It also has error handling added and the addition of a check forwindowto be defined so that it won't break components in a server-rendering or unit testing environment.I also upgraded
tslibas part of this PR so we can use[...spread]syntax in examples.