-
Notifications
You must be signed in to change notification settings - Fork 30
overridable: add dynamicParametrize function #300
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.
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
Open
palkerecsenyi
wants to merge
4
commits into
inveniosoftware:master
Choose a base branch
from
palkerecsenyi:dynamic-parametrize
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
214e88d
overridable: add dynamicParametrize function
palkerecsenyi 7c7a975
doc: add jsdoc comment for `dynamicParametrize`
palkerecsenyi 21cbcf0
feat: add existing props to context in `dynamicParametrize`
palkerecsenyi 17950c2
chore: add copyright message to fieldComponents.js
palkerecsenyi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
// This file is part of React-Invenio-Forms | ||
// Copyright (C) 2025 CERN. | ||
// | ||
// React-Invenio-Forms is free software; you can redistribute it and/or modify it | ||
// under the terms of the MIT License; see LICENSE file for more details. | ||
|
||
import { useFormikContext } from "formik"; | ||
import * as React from "react"; | ||
|
||
/** | ||
* Override the parameters of a component (similarly to `parametrize`) using certain available | ||
* context variables. | ||
* | ||
* Currently, the following arguments are passed into the `propsFactory` function: | ||
* - `existingProps`: the props originally passed into the component before the override | ||
* - `formValues`: an object of the values in the Formik form state | ||
* | ||
* The `propsFactory` function should return an object of the props to be used for overriding the | ||
* specified `Component` | ||
* | ||
* This function is adapted from `react-overridable`: https://github.com/indico/react-overridable/blob/d1ecfbec9993a461717824259900eec82d59f1e0/src/overridable.js#L7-L33 | ||
* | ||
* @param Component - the React component to override the parameters, as in `parametrize` from react-overridable. | ||
* @param {function} propsFactory - function returning the props to override the component with | ||
*/ | ||
export function dynamicParametrize(Component, propsFactory) { | ||
const ParametrizedComponent = (props) => { | ||
const { values } = useFormikContext(); | ||
const extraProps = propsFactory({ existingProps: props, formValues: values }); | ||
|
||
// Store the original component in an attribute | ||
if (Component.originalComponent) { | ||
Component = Component.originalComponent; | ||
} | ||
|
||
// overrideProps override props if there is a name collision | ||
const { children, ...attrProps } = { ...props, ...extraProps }; | ||
return React.createElement(Component, attrProps, children); | ||
}; | ||
|
||
const name = Component.displayName || Component.name; | ||
ParametrizedComponent.displayName = `Parametrized(${name})`; | ||
return ParametrizedComponent; | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
export { humanReadableBytes } from "./humanReadableBytes"; | ||
export { dropdownOptionsGenerator } from "./dropdownOptionsGenerator"; | ||
export { dynamicParametrize } from "./fieldComponents"; |
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.
Uh oh!
There was an error while loading. Please reload this page.