Skip to content

Use consistent naming in documentation #111

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
Jun 16, 2025
Merged

Use consistent naming in documentation #111

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
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ the ``keepDefault`` boolean in the slot should be set to ``true``. For organizat
(and therefore aren't defining a slot via JS config), ``keepDefault`` will default to ``true``, thus ensuring that the developer
experience isn't affected; the only change to note is that the component is now wrapped in a Plugin Slot.

If you need to use a plugin operation (e.g. Wrap, Hide, Modify) on default content, the ``widgetId`` you would use to refer to the content is ``defaults_contents``.
If you need to use a plugin operation (e.g. Wrap, Hide, Modify) on default content, the ``widgetId`` you would use to refer to the content is ``default_contents``.

Note: The default content will have a priority of 50, allowing for any plugins to appear before or after the default content.

Expand Down Expand Up @@ -271,7 +271,7 @@ one wrap operation. Each wrapper function takes in a ``component`` and ``id`` pr
{
op: PLUGIN_OPERATIONS.Wrap,
widgetId: 'default_content_in_slot',
widgetId: 'default_contents',
wrapper: wrapWidget,
}
Expand Down