Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(feat) Allow useConfig() to load configuration from other modules #751

Merged
merged 2 commits into from
Aug 18, 2023
Merged

(feat) Allow useConfig() to load configuration from other modules #751

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c1d4a5
(feat) Allow useConfig() to load configuration from other modules
ibacher Aug 16, 2023
46ca8fc
Changes from review
ibacher Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions packages/framework/esm-framework/docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1715,15 +1715,21 @@ ___

### useConfig

▸ **useConfig**<`T`\>(): `T`
▸ **useConfig**<`T`\>(`moduleName?`): `T`

Use this React Hook to obtain your module's configuration.

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | `Omit`<[`ConfigObject`](interfaces/ConfigObject.md), ``"Display conditions"`` \| ``"Translation overrides"``\> |
| `T` | `Record`<`string`, `any`\> |

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `moduleName` | `undefined` \| ``null`` \| `string` | `undefined` |

#### Returns

Expand Down
24 changes: 13 additions & 11 deletions packages/framework/esm-react-utils/src/useConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,26 +160,28 @@ function useNormalConfig(moduleName: string) {
/**
* Use this React Hook to obtain your module's configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

*/
export function useConfig<
T = Omit<ConfigObject, "Display conditions" | "Translation overrides">
>() {
export function useConfig<T = Record<string, any>>(
moduleName: string | null | undefined = undefined
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not

Suggested change
moduleName: string | null | undefined = undefined
moduleName?: string

?

) {
// This hook uses the config of the MF defining the component.
// If the component is used in an extension slot then the slot
// may override (part of) its configuration.
const { moduleName, extension } = useContext(ComponentContext);
const { moduleName: contextModuleName, extension } =
useContext(ComponentContext);
const finalModuleName = moduleName ?? contextModuleName;

if (!moduleName && !extension) {
if (!finalModuleName && !extension) {
throw Error(errorMessage);
}

const normalConfig = useNormalConfig(moduleName);
const normalConfig = useNormalConfig(finalModuleName);
const extensionConfig = useExtensionConfig(extension);
const config = useMemo(
() => ({
...normalConfig,
...extensionConfig,
}),
[normalConfig, extensionConfig]
() =>
finalModuleName === moduleName
? { ...normalConfig }
: { ...normalConfig, ...extensionConfig },
[moduleName, finalModuleName, normalConfig, extensionConfig]
);

return config as T;
Expand Down
Loading