Refactor Editor Constructor and Methods, Write Editor Getters #9110
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,15 @@ | ||
| class Editor { | ||
| // default parameters: | ||
| // defaultForm - when the Editor is initialized, there needs to be a default editor form: | ||
| // 1. the main comment form in multi-comment wikis, questions, & research notes. | ||
| // 2. the only editor form on /wiki/new and /wiki/edit | ||
| // elementIDPrefixes - the ID naming conventions are different depending on context: | ||
| // 1. multi-form pages with multiple comments: #comment-preview-123 | ||
| // 2. /wiki/new and /wiki/edit: #preview-main | ||
| constructor(defaultForm = "main", elementIDPrefixes = {}) { | ||
| this.commentFormID = defaultForm; | ||
| this.elementIDPrefixes = elementIDPrefixes; | ||
| this.textarea = $("#text-input-" + this.commentFormID); | ||
| // this will get deleted in the next few PRs, so collapsing into one line to pass codeclimate | ||
| this.templates = { 'blog': "## The beginning\n\n## What we did\n\n## Why it matters\n\n## How can you help", 'default': "## What I want to do\n\n## My attempt and results\n\n## Questions and next steps\n\n## Why I'm interested", 'support': "## Details about the problem\n\n## A photo or screenshot of the setup", 'event': "## Event details\n\nWhen, where, what\n\n## Background\n\nWho, why", 'question': "## What I want to do or know\n\n## Background story" }; | ||
|
|
||
|
|
@@ -27,93 +29,112 @@ class Editor { | |
| } | ||
| }); | ||
| } | ||
| setState(commentFormID) { | ||
| this.commentFormID = commentFormID; | ||
| this.textarea = $("#text-input-" + commentFormID); | ||
| $E.textarea.bind('input propertychange', $E.save); | ||
|
There was a problem hiding this comment. I changed most instances of There was a problem hiding this comment. Just to explain this a little further, it's because when |
||
| } | ||
| get textAreaElement() { | ||
| const textAreaID = "#text-input-" + this.commentFormID; | ||
| return $(textAreaID); | ||
| } | ||
|
There was a problem hiding this comment. Hmm, are these transpiled out in the asset pipeline? Any worries about internet explorer? I guess not these days! https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get I mean, i guess it's still 5% of usage: https://www.netmarketshare.com/browser-market-share.aspx?qprid=2&qpcustomd=0 what do you think? There was a problem hiding this comment. Oh huh... That's a good point. I hadn't checked this one out in MDN. I think they can be rewritten as regular methods! That won't be too hard. Can do it in another PR although... Do our users really use IE to access the website? Better safe than sorry I guess. |
||
| get textAreaValue() { | ||
| return this.textAreaElement.val(); | ||
| } | ||
| get previewElement() { | ||
| let previewIDPrefix = "#comment-preview-"; | ||
| if (this.elementIDPrefixes.hasOwnProperty("preview")) { | ||
| // eg. on /wiki/new & /wiki/edit, the preview element is called #preview-main | ||
| previewIDPrefix = "#" + this.elementIDPrefixes["preview"] + "-"; | ||
|
There was a problem hiding this comment. This is one of the main changes in this PR. Honestly, I have mixed feelings about it since it's a little weird, especially in the constructor. But I do think it's an okay workaround. I made this because there was some tension in having I wanted preview elements to be named So, this is my workaround. It's a little weird, but thanks to OOP, it can be scaled back or revised much easier. |
||
| } | ||
| const previewID = previewIDPrefix + this.commentFormID; | ||
| return $(previewID); | ||
| } | ||
| // wraps currently selected text in textarea with strings a and b | ||
| wrap(a, b, newlineDesired = false, fallback) { | ||
| const selectionStart = this.textAreaElement[0].selectionStart; | ||
| const selectionEnd = this.textAreaElement[0].selectionEnd; | ||
| const selection = fallback || this.textAreaValue.substring(selectionStart, selectionEnd); // fallback if nothing has been selected, and we're simply dealing with an insertion point | ||
|
|
||
| let newText = newlineDesired ? a + selection + b + "\n\n" : a + selection + b; // ie. ** + selection + ** (wrapping selection in bold) | ||
| const selectionStartsMidText = this.textAreaElement[0].selectionStart > 0; | ||
| if (newlineDesired && selectionStartsMidText) { newText = "\n" + newText; } | ||
|
|
||
| const textLength = this.textAreaValue.length; | ||
| const textBeforeSelection = this.textAreaValue.substring(0, selectionStart); | ||
| const textAfterSelection = this.textAreaValue.substring(selectionEnd, textLength); | ||
| this.textAreaElement.val(textBeforeSelection + newText + textAfterSelection); | ||
| } | ||
| bold() { | ||
| this.wrap('**', '**'); | ||
| } | ||
| italic() { | ||
| this.wrap('_', '_'); | ||
| } | ||
| link(uri) { | ||
| uri = prompt('Enter a URL'); | ||
| if (!uri) { uri = ""; } | ||
| this.wrap( | ||
| '[', | ||
| '](' + uri + ')' | ||
| ); | ||
| } | ||
| image(src) { | ||
| this.wrap( | ||
| '\n\n' | ||
| ); | ||
| } | ||
| // these header formatting functions are not used anywhere, so commenting them out for now to pass codeclimate: | ||
|
|
||
| // h1() { | ||
| // this.wrap('#','') | ||
| // } | ||
| h2() { | ||
| this.wrap('##', ''); | ||
| } | ||
| // h3() { | ||
| // this.wrap('###','') | ||
| // } | ||
| // h4() { | ||
| // this.wrap('####','') | ||
| // } | ||
| // h5() { | ||
| // this.wrap('#####','') | ||
| // } | ||
| // h6() { | ||
| // this.wrap('######','') | ||
| // } | ||
| // h7() { | ||
| // this.wrap('#######','') | ||
| // } | ||
| // this function is dedicated to Don Blair https://github.com/donblair | ||
| save() { | ||
| localStorage.setItem('plots:lastpost', this.textAreaValue); | ||
| } | ||
| recover() { | ||
| this.textAreaElement.val(localStorage.getItem('plots:lastpost')); | ||
| } | ||
| apply_template(template) { | ||
| if(this.textAreaValue == ""){ | ||
| this.textAreaElement.val(this.templates[template]) | ||
| }else if((this.textAreaValue == this.templates['event']) || (this.textAreaValue == this.templates['default']) || (this.textAreaValue == this.templates['support'])){ | ||
| this.textAreaElement.val(this.templates[template]) | ||
| }else{ | ||
| this.textAreaElement.val(this.textAreaValue+'\n\n'+this.templates[template]) | ||
| } | ||
| } | ||
| generate_preview(id,text) { | ||
| $('#' + id)[0].innerHTML = marked(text) | ||
| } | ||
| toggle_preview() { | ||
| // if the element is part of a multi-comment page, | ||
| // ensure to grab the current element and not the other comment element. | ||
| const previewBtn = $("#toggle-preview-button-" + this.commentFormID); | ||
| const dropzone = $("#dropzone-large-" + this.commentFormID); | ||
|
|
||
| this.previewElement[0].innerHTML = marked(this.textAreaValue); | ||
| this.previewElement.toggle(); | ||
| dropzone.toggle(); | ||
|
|
||
| this.toggleButtonPreviewMode(previewBtn); | ||
|
|
@@ -137,4 +158,4 @@ class Editor { | |
| previewBtn.text('Preview'); | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing the default parameter (
commentFormID = "main") here. I think it makes sense so that errors will be easier to catch.