add: comments to add clarity on how PLuginSlot knows what plugin URLs…

… to use
openedx · Sep 8, 2023 · 8c7d786 · 8c7d786
1 parent f69ff39
commit 8c7d786
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/example/src/PluginsPage.jsx b/example/src/PluginsPage.jsx
@@ -20,7 +20,7 @@ export default function PluginsPage() {
       </p>
       <div className="d-flex flex-column">
         <PluginSlot
-          id="example"
+          id="example" // this is how PluginSlot knows which set of plugin URLs to grab from JS config
           className="d-flex flex-column"
           pluginProps={{
             className: 'flex-grow-1',

diff --git a/src/plugins/PluginSlot.jsx b/src/plugins/PluginSlot.jsx
@@ -11,6 +11,9 @@ import PluginContainer from './PluginContainer';
 const PluginSlot = forwardRef(({
   as, id, intl, pluginProps, children, ...props
 }, ref) => {
+  /* the plugins below are obtained by the id passed into PluginSlot by the Host MFE. See example/src/PluginsPage.jsx
+  for an example of how PluginSlot is populated, and example/src/index.jsx for a dummy JS config that holds all plugins
+  */
   const { plugins, keepDefault } = usePluginSlot(id);
 
   const { fallback } = pluginProps;