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

Remove HtmlEditor render modifier #8408

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Remove HtmlEditor render modifier #8408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9ae2fd2
removed render modifiers
michaelchadwick Mar 8, 2025
cf66ebf
update lint-todo
michaelchadwick Mar 8, 2025
67d7d56
removed terrible template stuff and added custom modifier that trigge…
michaelchadwick Mar 10, 2025
afec180
improved loading logic
michaelchadwick Mar 12, 2025
e30993a
made TrackedAsyncData method more descriptive
michaelchadwick Mar 12, 2025
04e333e
added comment doc for FroalaEditor instance access
michaelchadwick Mar 12, 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
2 changes: 0 additions & 2 deletions packages/ilios-common/.lint-todo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
add|ember-template-lint|no-at-ember-render-modifiers|2|2|2|2|ad17d66e0fe1720bc8ddedc12dff3a105709765c|1731542400000|1762646400000|1793750400000|addon/components/html-editor.hbs
add|ember-template-lint|no-at-ember-render-modifiers|3|2|3|2|d39abab22a3e75d93f69335da422e7ef73b36283|1731542400000|1762646400000|1793750400000|addon/components/html-editor.hbs
add|ember-template-lint|no-at-ember-render-modifiers|3|2|3|2|1fb6f249958ee245e6abc413681c9fe096120cef|1731542400000|1762646400000|1793750400000|addon/components/session-copy.hbs
add|ember-template-lint|no-at-ember-render-modifiers|4|2|4|2|856162ce473b112534763bb641aae7a4422d8e2e|1731542400000|1762646400000|1793750400000|addon/components/session-copy.hbs
add|ember-template-lint|no-at-ember-render-modifiers|3|2|3|2|23cd787c79c34a628dadb6e96dd4004d42eebb79|1731542400000|1762646400000|1793750400000|addon/components/session-offerings-list.hbs
Expand Down
17 changes: 9 additions & 8 deletions packages/ilios-common/addon/components/html-editor.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
<div
{{did-insert (perform this.loadEditor) this.options}}
{{did-update (perform this.loadEditor) this.options}}
id={{this.editorId}}
class="html-editor"
data-test-html-editor
data-test-load-finished={{this.loadFinished}}>
</div>
{{#if this.loadFroalaData.isResolved}}
<div
{{this.editorInserted this.options}}
id={{this.editorId}}
class="html-editor"
data-test-html-editor
data-test-load-finished={{this.loadFinished}}>
</div>
{{/if}}
52 changes: 27 additions & 25 deletions packages/ilios-common/addon/components/html-editor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
import Component from '@glimmer/component';
import { service } from '@ember/service';
import { tracked } from '@glimmer/tracking';
import { restartableTask } from 'ember-concurrency';
import { cached, tracked } from '@glimmer/tracking';
import { loadFroalaEditor } from 'ilios-common/utils/load-froala-editor';
import { guidFor } from '@ember/object/internals';
import { modifier } from 'ember-modifier';
import { TrackedAsyncData } from 'ember-async-data';

export default class HtmlEditorComponent extends Component {
@service intl;
@tracked editor = null;
@tracked editorId = null;
@tracked loadFinished = false;

editor = null;
defaultButtons = {
moreText: {
buttons: ['bold', 'italic', 'subscript', 'superscript', 'formatOL', 'formatUL', 'insertLink'],
Expand All @@ -27,6 +28,29 @@ export default class HtmlEditorComponent extends Component {
this.editorId = guidFor(this);
}

@cached
get loadFroalaData() {
return new TrackedAsyncData(loadFroalaEditor());
}

editorInserted = modifier((element, [options]) => {
if (!this.editor) {
const { FroalaEditor } = this.loadFroalaData.value;
const component = this;
// getting the Froala instance inside its constructor callback
// https://froala.com/wysiwyg-editor/examples/getHTML/
this.editor = new FroalaEditor(element, options, function () {
this.html.set(component.args.content);
if (component.args.autoFocus) {
this.events.focus();
}
component.loadFinished = true;
});
}

return true;
});

get options() {
return {
key: 'Kb3A3pE2E2A1E4G4I4oCd2ZSb1XHi1Cb2a1KIWCWMJHXCLSwG1G1B2C1B1C7F6E1E4F4==',
Expand Down Expand Up @@ -73,26 +97,4 @@ export default class HtmlEditorComponent extends Component {
this.editor = null;
}
}
createEditor(element, options) {
return new Promise((resolve) => {
loadFroalaEditor().then(({ FroalaEditor }) => {
new FroalaEditor(element, options, function () {
resolve(this);
});
});
});
}

loadEditor = restartableTask(async (element, [options]) => {
if (!this.editor) {
this.editor = await this.createEditor(element, options);
this.editor.html.set(this.args.content);
if (this.args.autofocus) {
this.editor.events.focus();
}
this.loadFinished = true;
}

return true;
});
}