Skip to content

PRO-8708: bring back passing of the actual area options in the form developers expect to see them to custom insert menu item components #5162

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
boutell merged 1 commit into from
Nov 18, 2025
Merged

PRO-8708: bring back passing of the actual area options in the form developers expect to see them to custom insert menu item components #5162

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* `@apostrophecms/migration:requirements` handler now runs the migration requirements like `insertIfMissing`, `implementParkAllInDefaultLocale`, `replicate` and `implementParkAllInOtherLocales`.
* Bump nodemailer to v7.x.
* Improves client error log when unable to render a widget.
* Rich text `styles` are once again available to insert menu items, such as our optional `@apostrophecms/ai-helper` module.

### Fixes

Expand Down
120 changes: 66 additions & 54 deletions modules/@apostrophecms/rich-text-widget/ui/apos/components/AposRichTextWidgetEditor.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
:name="item"
:menu-item="insertMenu[item]"
:editor="editor"
:editor-options="editorOptions"
:editor-options="getOptionsForInsertItem()"
@done="doSuppressInsertMenu"
@set-active-insert-menu="setActiveInsertMenu"
/>
Expand Down Expand Up @@ -242,59 +242,7 @@ export default {
return this.moduleOptions.defaultOptions;
},
editorOptions() {
// Deep clone to prevent runaway recursive rendering
// as the subproperties are mutated in several places
// by this code and its dependencies
let activeOptions = klona(this.options);

activeOptions = {
...activeOptions,
...this.enhanceStyles(
activeOptions.styles?.length
? activeOptions.styles
: this.defaultOptions.styles
)
};
delete activeOptions.styles;

// Allow default options to pass through if `false`
Object.keys(this.defaultOptions).forEach((option) => {
if (option !== 'styles') {
activeOptions[option] = (activeOptions[option] !== undefined)
? activeOptions[option]
: this.defaultOptions[option];
}
});

activeOptions.className = (activeOptions.className !== undefined)
? activeOptions.className
: this.moduleOptions.className;

if (activeOptions.toolbar.includes('styles')) {
activeOptions.toolbar = activeOptions.toolbar.filter(t => t !== 'styles');
if (activeOptions.marks.length) {
activeOptions.toolbar = [ 'marks', ...activeOptions.toolbar ];
}
if (activeOptions.nodes.length) {
activeOptions.toolbar = [ 'nodes', ...activeOptions.toolbar ];
}
}

// The table tool is no longer part of the toolbar but will
// automatically appear when interacting with a table element,
// no configuration needed. If:
// 1. The table is configured for the toolbar but not insert, move it
// 2. remove the table tool from the toolbar
if (activeOptions.toolbar?.some(tool => tool === 'table')) {
if (!activeOptions.insert?.some(tool => tool === 'table')) {
activeOptions.insert = [
...(activeOptions.insert || []),
'table'
];
}
activeOptions.toolbar = activeOptions.toolbar.filter(tool => tool !== 'table');
}
return activeOptions;
return this.getOptionsForEditor();
},
autofocus() {
// Only true for a new rich text widget
Expand Down Expand Up @@ -488,6 +436,70 @@ export default {
apos.bus.$off('apos-refreshing', this.onAposRefreshing);
},
methods: {
// Insert menu items just want to know what the original options were,
// while "editorOptions" has morphed into a different, internal
// representation
getOptionsForInsertItem() {
return klona({
...this.defaultOptions,
...this.options
});
},
getOptionsForEditor() {

@boutell boutell Nov 18, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just the old editorOptions code moved to a method.

// Deep clone to prevent runaway recursive rendering
// as the subproperties are mutated in several places
// by this code and its dependencies
let activeOptions = klona(this.options);

activeOptions = {
...activeOptions,
...this.enhanceStyles(
activeOptions.styles?.length
? activeOptions.styles
: klona(this.defaultOptions.styles)
)
};
delete activeOptions.styles;

// Allow default options to pass through if `false`
Object.keys(this.defaultOptions).forEach((option) => {
if (option !== 'styles') {
activeOptions[option] = (activeOptions[option] !== undefined)
? activeOptions[option]
: this.defaultOptions[option];
}
});

activeOptions.className = (activeOptions.className !== undefined)
? activeOptions.className
: this.moduleOptions.className;

if (activeOptions.toolbar.includes('styles')) {
activeOptions.toolbar = activeOptions.toolbar.filter(t => t !== 'styles');
if (activeOptions.marks.length) {
activeOptions.toolbar = [ 'marks', ...activeOptions.toolbar ];
}
if (activeOptions.nodes.length) {
activeOptions.toolbar = [ 'nodes', ...activeOptions.toolbar ];
}
}

// The table tool is no longer part of the toolbar but will
// automatically appear when interacting with a table element,
// no configuration needed. If:
// 1. The table is configured for the toolbar but not insert, move it
// 2. remove the table tool from the toolbar
if (activeOptions.toolbar?.some(tool => tool === 'table')) {
if (!activeOptions.insert?.some(tool => tool === 'table')) {
activeOptions.insert = [
...(activeOptions.insert || []),
'table'
];
}
activeOptions.toolbar = activeOptions.toolbar.filter(tool => tool !== 'table');
}
return activeOptions;
},
showTableControls() {
return this.editor?.isActive('table') ?? false;
},
Expand Down
Loading