Custom storage for shortcuts #139
Open
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
This adds a protocol to allow for custom storage. It will default to UserDefaults unless anything else has been specified prior to calling KeyboardShortcuts.initialize()
| @@ -137,7 +138,11 @@ public enum KeyboardShortcuts { | |||
| guard !isInitialized else { | |||
| return | |||
| } | |||
|
|
|||
|
|
|||
| if storageProvider == nil { | |||
There was a problem hiding this comment.
I suggest that a 'else' statement should be added to this 'if' just in case. This will help cover border effects.
| @@ -277,29 +282,28 @@ public enum KeyboardShortcuts { | |||
| You would usually not need this as the user would be the one setting the shortcut in a settings user-interface, but it can be useful when, for example, migrating from a different keyboard shortcuts package. | |||
| */ | |||
| public static func setShortcut(_ shortcut: Shortcut?, for name: Name) { | |||
There was a problem hiding this comment.
Adding comments about the parameters will help the understanding of this method.
This has been correctly done in 'Name.swift' 👍🏻
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.
Related to #18, I've tried to implement a protocol to allow for custom storage implementations. It still defaults to using UserDefaults unless anything else has been specified before running
KeyboardShortcuts.initialize().You can consider this WIP, since it would probably be nice to add more tests etc, and documentation with examples how to use it.