Skip to content

docs: fix README rendering #100

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

Merged
merged 1 commit into from
Jan 6, 2025
Merged

docs: fix README rendering #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ file as well to define its plugin slots.
// env.config.js

import { DIRECT_PLUGIN, IFRAME_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';

// import any additional dependencies or functions to be used for each plugin operation
import Sidebar from './widgets/social/Sidebar';
import SocialMediaLink from './widgets/social/SocialMediaLink';
Expand Down Expand Up @@ -168,12 +168,12 @@ If you need to use a plugin operation (e.g. Wrap, Hide, Modify) on default conte
Note: The default content will have a priority of 50, allowing for any plugins to appear before or after the default content.

Plugin Operations
=================
`````````````````

There are four plugin operations that each require specific properties.

Insert a Direct Plugin
``````````````````````
''''''''''''''''''''''

The Insert operation will add a widget in the plugin slot. The contents required for a Direct Plugin is the same as
is demonstrated in the Default Contents section above, with the ``content`` key being optional.
Expand All @@ -196,7 +196,7 @@ is demonstrated in the Default Contents section above, with the ``content`` key
}

Insert an iFrame Plugin
```````````````````````
'''''''''''''''''''''''

The Insert operation will add a widget in the plugin slot. The contents required for an iFrame Plugin is the same as
is demonstrated in the Default Contents section above.
Expand All @@ -220,7 +220,7 @@ is demonstrated in the Default Contents section above.
}

Modify
``````
''''''

The Modify operation allows us to modify the contents of a widget, including its id, type, content, RenderWidget function,
or its priority. The operation requires the id of the widget that will be modified and a function to make those changes.
Expand Down Expand Up @@ -248,7 +248,7 @@ or its priority. The operation requires the id of the widget that will be modifi
}

Wrap
````
''''

Unlike Modify, the Wrap operation adds a React component around the widget, and a single widget can receive more than
one wrap operation. Each wrapper function takes in a ``component`` and ``id`` prop.
Expand Down Expand Up @@ -276,7 +276,7 @@ one wrap operation. Each wrapper function takes in a ``component`` and ``id`` pr
}

Hide
````
''''

The Hide operation will simply hide whatever content is desired. This is generally used for the default content.

Expand Down Expand Up @@ -304,7 +304,7 @@ Fallback Behavior
-----------------

Setting a Fallback component
''''''''''''''''''''''''''''
````````````````````````````
The two main places to configure a fallback component for a given implementation are in the PluginSlot props and in the JS configuration. The JS configuration fallback will be prioritized over the PluginSlot props fallback.

PluginSlot props
Expand Down
Loading