feat: support merging base component props, custom props, and pluginProps via slotOptions.mergeProps
#84
There are no files selected for viewing
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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,80 @@ | ||
| import { | ||
| Container, Row, Col, Stack, | ||
| } from '@openedx/paragon'; | ||
|
|
||
| import PluginSlotWithModifyDefaultContentsLink from './pluginSlots/PluginSlotWithModifyDefaultContentsLink'; | ||
| import PluginSlotWithModifyDefaultContents from './pluginSlots/PluginSlotWithModifyDefaultContents'; | ||
| import PluginSlotWithInsert from './pluginSlots/PluginSlotWithInsert'; | ||
| import PluginSlotWithModifyWrapHide from './pluginSlots/PluginSlotWithModifyWrapHide'; | ||
| import PluginSlotWithModularPlugins from './pluginSlots/PluginSlotWithModularPlugins'; | ||
| import PluginSlotWithoutDefault from './pluginSlots/PluginSlotWithoutDefault'; | ||
|
|
||
| const pluginExamples = [ | ||
|
There was a problem hiding this comment. [inform/context] Refactored |
||
| { | ||
| id: 'plugin-operation-insert', | ||
| label: 'Plugin Operation: Insert', | ||
| Component: PluginSlotWithInsert, | ||
| }, | ||
| { | ||
| id: 'plugin-operation-modify-wrap-hide', | ||
| label: 'Plugin Operation: Modify, Wrap, and Hide', | ||
| Component: PluginSlotWithModifyWrapHide, | ||
| }, | ||
| { | ||
| id: 'plugin-operation-modify-default-content', | ||
| label: 'Plugin Operation: Modify Default Content', | ||
| Component: PluginSlotWithModifyDefaultContents, | ||
| }, | ||
| { | ||
| id: 'plugin-operation-modify-default-content-link', | ||
| label: 'Plugin Operation: Modify Default Content (Link)', | ||
| Component: PluginSlotWithModifyDefaultContentsLink, | ||
| }, | ||
| { | ||
| id: 'direct-plugins-modular-components', | ||
| label: 'Direct Plugins Using Modular Components', | ||
| Component: PluginSlotWithModularPlugins, | ||
| }, | ||
| { | ||
| id: 'no-default-content', | ||
| label: 'Default Content Set to False', | ||
| Component: PluginSlotWithoutDefault, | ||
| }, | ||
| ]; | ||
|
|
||
| export default function ExamplePage() { | ||
| return ( | ||
| <main> | ||
| <Container size="lg" className="py-3"> | ||
| <Row> | ||
| <Col> | ||
| <h1>Plugins Page</h1> | ||
| <p> | ||
| This page is here to help test the plugins module. A plugin configuration can be added in | ||
| index.jsx and this page will display that plugin. | ||
| </p> | ||
| <p> | ||
| To do this, a plugin MFE must be running on some other port. | ||
| To make it a more realistic test, you may also want to edit your | ||
| /etc/hosts file (or your system's equivalent) to provide an alternate domain for | ||
| 127.0.0.1 at which you can load the plugin. | ||
| </p> | ||
| <h2>Examples</h2> | ||
| <Stack gap={3}> | ||
| <ul> | ||
| {pluginExamples.map(({ id, label }) => ( | ||
| <li key={id}> | ||
| <a href={`#${id}`}>{label}</a> | ||
| </li> | ||
| ))} | ||
| </ul> | ||
|
Comment on lines
+58
to
+64
There was a problem hiding this comment. [inform/context] Includes a small list of skip links to navigate to specific example(s), without necessarily needing to scroll to find a specific example. |
||
| <Stack gap={5}> | ||
| {pluginExamples.map(({ Component, id, label }) => <Component key={id} id={id} label={label} />)} | ||
| </Stack> | ||
| </Stack> | ||
| </Col> | ||
| </Row> | ||
| </Container> | ||
| </main> | ||
| ); | ||
| } | ||
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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| import React from 'react'; | ||
|
|
||
| import { PluginSlot } from '@openedx/frontend-plugin-framework'; | ||
| import classNames from 'classnames'; | ||
|
|
||
|
|
||
| // Example component used as the default childen within a PluginSlot | ||
| const Username = ({ className, onClick, ...rest }) => { | ||
| const authenticatedUser = { username: 'testuser' }; | ||
| const { username } = authenticatedUser; | ||
| return ( | ||
| <span | ||
| className={classNames('default-classname', className)} | ||
| onClick={(e) => { | ||
| console.log('Username clicked!', 'default', e); | ||
| onClick?.(e); | ||
| }} | ||
| {...rest} | ||
| > | ||
| {username} | ||
| </span> | ||
| ); | ||
| }; | ||
|
|
||
| const UsernameWithPluginContent = ({ className, onClick, content = {} }) => { | ||
| const { | ||
| className: classNameFromPluginContent, | ||
| onClick: onClickFromPluginContent, | ||
| ...contentRest | ||
| } = content; | ||
| const updatedProps = { | ||
| className: classNames(className, classNameFromPluginContent), | ||
| onClick: (e) => { | ||
| onClick?.(e); | ||
| onClickFromPluginContent?.(e); | ||
| }, | ||
| }; | ||
| return <Username {...updatedProps} {...contentRest} />; | ||
| }; | ||
|
|
||
| function PluginSlotWithModifyDefaultContents({ id, label }) { | ||
| return ( | ||
| <div className="border border-primary px-3"> | ||
| <h3 id={id}>{label}</h3> | ||
| <p> | ||
| The following <code>PluginSlot</code> examples demonstrate the <code>PLUGIN_OPERATIONS.Modify</code> operation, when | ||
| the <code>widgetId</code> is <code>default_contents</code>. Any configured, custom plugin <code>content</code> is | ||
| merged with any existing props passed to the component(s) represented by <code>default_contents</code>. | ||
| </p> | ||
| <ul> | ||
| <li>Custom <code>className</code> overrides are concatenated with the <code>className</code> prop passed to the <code>default_contents</code> component(s), if any.</li> | ||
| <li>Custom <code>style</code> overrides are shallow merged with the <code>style</code> prop passed to the <code>default_contents</code> component(s), if any.</li> | ||
| <li>Custom event handlers (e.g., <code>onClick</code>) are executed in sequence, after any event handlers passed to the <code>default_contents</code> component(s), if any.</li> | ||
| </ul> | ||
| <PluginSlot | ||
| id="slot_with_username_pii" | ||
| as="div" | ||
| // Default slotOptions | ||
| slotOptions={{ | ||
| mergeProps: false, | ||
| }} | ||
adamstankiewicz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| > | ||
| <UsernameWithPluginContent | ||
| className="tetsing" | ||
| onClick={(e) => { | ||
| console.log('Username clicked!', 'prop', e); | ||
| }} | ||
| /> | ||
| </PluginSlot> | ||
| <PluginSlot | ||
| id="slot_with_username_pii" | ||
| as="div" | ||
| slotOptions={{ | ||
| mergeProps: true, | ||
| }} | ||
| > | ||
| <Username | ||
| className="d-block abc123" | ||
| onClick={(e) => { | ||
| console.log('Username clicked!', 'prop', e); | ||
| }} | ||
| /> | ||
| {/* <Username className="ghi789" /> // Note: uncomment to see example of incorrectly using multiple `children` elements within `PluginSlot` */} | ||
| </PluginSlot> | ||
| <PluginSlot | ||
| id="slot_with_username_pii" | ||
| as="div" | ||
| pluginProps={{ | ||
| className: 'bg-accent-b', | ||
| onClick: (e) => { console.log('Username clicked!', 'pluginProps', e); }, | ||
| }} | ||
| slotOptions={{ | ||
| mergeProps: true, | ||
| }} | ||
| > | ||
| <Username | ||
| className="ghi789" | ||
| onClick={(e) => { | ||
| console.log('Username clicked!', 'prop', e); | ||
| }} | ||
| /> | ||
| </PluginSlot> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export default PluginSlotWithModifyDefaultContents; | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[inform/context] Passing the
keyhere does not resolve the React console warning; Thekeyneeds to be applied to the parentwrapWidgetfunction as opposed to a node withinwrapWidget, given its acting as a component (e.g.,wrapWidgetis the display name of the rendered component).