(feat) Allow useConfig() to load configuration from other modules #751
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
|
Size Change: +372 B (0%) Total Size: 2.13 MB
ℹ️ View Unchanged
|
brandones
reviewed
Aug 16, 2023
| T = Omit<ConfigObject, "Display conditions" | "Translation overrides"> | ||
| >() { | ||
| export function useConfig<T = Record<string, any>>( | ||
| moduleName: string | null | undefined = undefined |
There was a problem hiding this comment.
Why not
Suggested change
| moduleName: string | null | undefined = undefined | |
| moduleName?: string |
?
brandones
reviewed
Aug 16, 2023
| @@ -160,26 +160,28 @@ function useNormalConfig(moduleName: string) { | |||
| /** | |||
| * Use this React Hook to obtain your module's configuration. | |||
There was a problem hiding this comment.
I suggest renaming moduleName to something like foreignModuleName and adding a docstring comment explaining that it is not needed for normal use and indeed should not be used if it can be avoided. Making useConfig take an options object as its argument so that users have to type out foreignModuleName or whatever in order to pass one might be even better.
brandones
approved these changes
Aug 18, 2023
4 tasks
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.
Requirements
For changes to apps
If applicable
Summary
Occasionally, we want a module to be able to load the configuration from a different module; this is possible in the underlying configuration API, but not via the
useConfig()hook. This PR just extends theuseConfig()hook to allow you to pass an optional module name, in which caseuseConfig()will return the configuration of that module. Note that the usage of this feature is discouraged as it may add unnecessary coupling between modules.Screenshots
Related Issue
Other