Skip to content
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

pkp/pkp-lib#9366 Upgrade to TinyMCE6 #477

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

pkp/pkp-lib#9366 Upgrade to TinyMCE6 #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f004008
pkp/pkp-lib#9366 Upgrade tinymce from v5 to v6
blesildaramirez Jan 6, 2025
f360e15
pkp/pkp-lib#9366 Remove array push for a custom plugin in tinymce
blesildaramirez Jan 6, 2025
49dc22f
pkp/pkp-lib#9366 Safeguard setting toolbar props for tinymce
blesildaramirez Jan 6, 2025
bf5e927
pkp/pkp-lib#9366 Resolve issue with toolbar pkpAttachFiles for tinymc…
blesildaramirez Jan 6, 2025
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
25 changes: 14 additions & 11 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"@highlightjs/vue-plugin": "^2.1.0",
"@lk77/vue3-color": "^3.0.6",
"@storybook/test": "^8.0.5",
"@tinymce/tinymce-vue": "^5.1.1",
"@tinymce/tinymce-vue": "^6.1.0",
"@vue-a11y/announcer": "^3.1.5",
"@vueuse/core": "^10.5.0",
"chart.js": "^4.4.3",
Expand All @@ -34,7 +34,7 @@
"pinia": "^2.1.7",
"primevue": "^4.0.5",
"tiny-emitter": "^2.1.0",
"tinymce": "^5.10.7",
"tinymce": "^6.1.0",
"uuid": "^9.0.0",
"vue": "^3.3.8",
"vue-chartjs": "^5.2.0",
Expand Down
9 changes: 6 additions & 3 deletions src/components/Composer/Composer.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,9 @@
:all-errors="errors"
:init="bodyInit"
:form-id="id"
plugins="link"
:plugins="['link']"
size="large"
toolbar="bold italic superscript subscript | link"
:toolbar="toolbar"
:value="body"
:prepared-content="compiledVariables"
:insert-label="insertLabel"
Expand Down Expand Up @@ -553,6 +553,7 @@ export default {
searchPhrase: '',
searchResults: [],
showSearchResultCount: 10,
toolbar: 'bold italic superscript subscript | link',
};
},
computed: {
Expand All @@ -577,6 +578,9 @@ export default {
return {};
}
let self = this;

self.toolbar += ' | pkpAttachFiles';

return {
setup: function (editor) {
editor.ui.registry.addButton('pkpAttachFiles', {
Expand All @@ -592,7 +596,6 @@ export default {
});
},
});
editor.settings.toolbar += ' | pkpAttachFiles';
},
};
},
Expand Down
7 changes: 6 additions & 1 deletion src/components/Form/fields/FieldPreparedContent.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export default {
* for accepted props
*/
textareaProps() {
const self = this;
let props = {};
let parent = FieldRichTextarea;
while (parent) {
Expand All @@ -86,6 +87,11 @@ export default {
});
parent = parent.extends ? parent.extends : null;
}

if (self.preparedContent.length && typeof props.toolbar === 'string') {
props.toolbar += '| pkpInsert';
}

return props;
},

Expand Down Expand Up @@ -120,7 +126,6 @@ export default {
self.openInsertModal();
},
});
editor.settings.toolbar += ' | pkpInsert';
}
};
return {
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/fields/FieldRichText.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export const Base = {
label: 'Title',
groupId: 'default',
isMultilingual: false,
plugins: 'paste',
plugins: [],
toolbar: 'formatgroup',
value: '',
i18nFormattingLabel: 'Formatting',
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/fields/FieldRichTextarea.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The editor will support image uploads, which are placed in the user's directory
...
uploadUrl: 'http://journal.com/api/v1/_uploadPublicFile',
toolbar: 'bold italic | link | image',
plugins: 'paste,link,image'
plugins: ['link','image']
}
```

Expand Down
8 changes: 6 additions & 2 deletions src/components/Form/fields/FieldRichTextarea.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export const Base = {
...FieldBaseMock,
...FieldRichTextareaBioMock,
isMultilingual: false,
value: '',
},
};

Expand All @@ -38,10 +39,11 @@ export const MediumToolbar = {
...FieldBaseMock,
...FieldRichTextareaBioMock,
isMultilingual: false,
value: '',

toolbar:
'bold italic superscript subscript | link | blockquote bullist numlist',
plugins: 'paste,link,noneditable,lists',
plugins: ['link', 'lists'],
},
};

Expand All @@ -50,10 +52,11 @@ export const HeavyToolbar = {
...FieldBaseMock,
...FieldRichTextareaBioMock,
isMultilingual: false,
value: '',

toolbar:
'bold italic superscript subscript | link | blockquote bullist numlist | image | code',
plugins: 'paste,link,lists,image,code',
plugins: ['link', 'lists', 'image', 'code'],
},
};

Expand All @@ -64,5 +67,6 @@ export const WordLimit = {
wordLimit: 200,
wordCountLabel: 'Word Count: {$count}/{$limit}',
isMultilingual: false,
value: '',
},
};
9 changes: 2 additions & 7 deletions src/components/Form/fields/FieldRichTextarea.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,7 @@ import 'tinymce/plugins/code';
import 'tinymce/plugins/image';
import 'tinymce/plugins/link';
import 'tinymce/plugins/lists';
import 'tinymce/plugins/noneditable';
import 'tinymce/plugins/paste';
import 'tinymce/models/dom';
import Editor from '@tinymce/tinymce-vue';
import FieldBase from './FieldBase.vue';
import debounce from 'debounce';
Expand Down Expand Up @@ -132,7 +131,7 @@ export default {
},
/** Specify plugins the TinyMCE editor should load. See [TinyMCE documentation](https://www.tiny.cloud/docs/configure/integration-and-setup/#plugins). */
plugins: {
type: String,
type: Array,
required: true,
},
/** One of `default` or `large`. */
Expand Down Expand Up @@ -210,10 +209,6 @@ export default {
const smartyVariable = /\{\$(\w*)\}/.exec(url);
if (smartyVariable) {
url = smartyVariable[0];
} else {
this.settings.urlconverter_callback = false; // eslint-disable-line
url = this.convertURL(url);
this.settings.urlconverter_callback = urlConverterCallback; // eslint-disable-line
}
return url;
};
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/mocks/field-rich-textarea-abstract.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export default {
label: 'Abstract',
description: 'The abstract must be less than 300 words.',
isRequired: true,
plugins: 'paste,link,noneditable',
plugins: ['link'],
toolbar: 'bold italic superscript subscript | link',
value: {
en: '<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>',
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/mocks/field-rich-textarea-bio.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export default {
component: 'field-rich-textarea',
label: 'Bio Statement',
groupId: 'profile',
plugins: 'paste,link,noneditable',
plugins: ['link'],
toolbar: 'bold italic superscript subscript | link',
tooltip:
'Your biographical statement will usually include your department and rank, and may include research interests or key publications.',
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/mocks/field-rich-textarea-description.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export default {
component: 'field-rich-textarea',
label: 'Journal Description',
value: '',
plugins: 'paste,link,lists,image,code',
plugins: ['link', 'lists', 'image', 'code'],
toolbar:
'bold italic superscript subscript | link | blockquote bullist numlist | image | code',
};
2 changes: 1 addition & 1 deletion src/components/Form/mocks/field-rich-textarea-signature.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default {
},
groupId: 'contact',
isMultilingual: true,
plugins: 'paste,link,noneditable',
plugins: ['link'],
toolbar: 'bold italic superscript subscript | link',
value: {
en: '',
Expand Down
4 changes: 2 additions & 2 deletions src/components/Form/mocks/form-announcement.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export default {
component: 'field-rich-textarea',
label: 'Short Description',
isMultilingual: true,
plugins: 'paste,link,noneditable',
plugins: ['link'],
toolbar: 'bold italic superscript subscript | link',
value: {
en: '',
Expand All @@ -35,7 +35,7 @@ export default {
label: 'Description',
isMultilingual: true,
size: 'large',
plugins: 'paste,link,noneditable',
plugins: ['link'],
toolbar: 'bold italic superscript subscript | link',
value: {
en: '',
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/mocks/form-contributors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export default {
isMultilingual: true,
isInert: false,
value: {en: '', es: '', fr_CA: '', pt: ''},
plugins: 'paste,link,noneditable',
plugins: ['link'],
toolbar: 'bold italic superscript subscript | link',
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/mocks/form-email-template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default {
'Use the "Insert Content" button to use dynamic data in your template. These variables will be replaced with real data before the email is sent.',
isMultilingual: true,
size: 'large',
plugins: 'paste,link,lists',
plugins: ['link', 'lists'],
toolbar:
'bold italic superscript subscript | link | blockquote bullist numlist',
value: {
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/mocks/form-for-the-editors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default {
'Add any information that you think our editorial staff should know when evaluating your submission.',
value: '',
toolbar: 'bold italic superscript subscript | link',
plugins: 'paste,link',
plugins: ['link'],
groupId: 'default',
},
],
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/mocks/form-relations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default {
{
...FieldRichTextareaAbstract,
toolbar: 'bold italic superscript subscript | link',
plugins: 'paste,link',
plugins: ['link'],
groupId: 'default',
},
],
Expand Down
2 changes: 1 addition & 1 deletion src/components/Form/mocks/form-title-abstract.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default {
{
...FieldRichTextareaAbstract,
toolbar: 'bold italic superscript subscript | link',
plugins: 'paste,link',
plugins: ['link'],
groupId: 'default',
},
],
Expand Down
6 changes: 3 additions & 3 deletions src/pages/dashboard/mocks/pageInitConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ export default {
value: [],
i18nFormattingLabel: 'Formatting',
toolbar: 'formatgroup',
plugins: 'paste',
plugins: [],
size: 'oneline',
validElements: 'b,i,u,sup,sub',
},
Expand All @@ -513,7 +513,7 @@ export default {
value: [],
i18nFormattingLabel: 'Formatting',
toolbar: 'formatgroup',
plugins: 'paste',
plugins: [],
size: 'oneline',
validElements: 'b,i,u,sup,sub',
},
Expand All @@ -526,7 +526,7 @@ export default {
isMultilingual: true,
isInert: false,
value: [],
plugins: 'paste,link,noneditable',
plugins: ['link'],
size: 'large',
toolbar: 'bold italic superscript subscript | link',
},
Expand Down
Loading