paragon icon indicating copy to clipboard operation
paragon copied to clipboard

docs: add TextEditor ADR

Open connorhaugh opened this issue 2 years ago β€’ 4 comments

This ADR proposes a Paragon TextEditor component as a pass through of Tinymce, an existing WYSIWIG text editor, with standardization. This follows the suggested reverse process for engineers to submit things to pwg

connorhaugh avatar Mar 09 '22 14:03 connorhaugh

βœ”οΈ Deploy Preview for paragon-edx ready!

πŸ”¨ Explore the source changes: 065ece6b5b887fe1f6e1d78273025cc42e0a4410

πŸ” Inspect the deploy log: https://app.netlify.com/sites/paragon-edx/deploys/622e7cc99a5de7000824b975

😎 Browse the preview: https://deploy-preview-1131--paragon-edx.netlify.app

netlify[bot] avatar Mar 09 '22 14:03 netlify[bot]

βœ”οΈ Deploy Preview for paragon-openedx ready!

πŸ”¨ Explore the source changes: 065ece6b5b887fe1f6e1d78273025cc42e0a4410

πŸ” Inspect the deploy log: https://app.netlify.com/sites/paragon-openedx/deploys/622e7cc95da0920008e031e9

😎 Browse the preview: https://deploy-preview-1131--paragon-openedx.netlify.app

netlify[bot] avatar Mar 09 '22 14:03 netlify[bot]

Codecov Report

Merging #1131 (065ece6) into master (66438b6) will increase coverage by 0.04%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1131      +/-   ##
==========================================
+ Coverage   90.59%   90.64%   +0.04%     
==========================================
  Files         190      191       +1     
  Lines        2989     3013      +24     
  Branches      657      666       +9     
==========================================
+ Hits         2708     2731      +23     
- Misses        268      269       +1     
  Partials       13       13              
Impacted Files Coverage Ξ”
src/Menu/SelectMenu.jsx 63.49% <0.00%> (ΓΈ)
src/Sticky/index.jsx 95.83% <0.00%> (ΓΈ)

Continue to review full report at Codecov.

Legend - Click here to learn more Ξ” = absolute <relative> (impact), ΓΈ = not affected, ? = missing data Powered by Codecov. Last update 66438b6...065ece6. Read the comment docs.

codecov[bot] avatar Mar 09 '22 15:03 codecov[bot]

I believe this makes sense in the long term, but for the short-term, the team needs w/rt the tinyMCE installation are going to leave them with a much less configurable option than we would want for Paragon consumption, and the TnL squad will not have the bandwidth to continue pressing on this from a component standardization perspective, so that work will need to get forwarded to the FWG or PWG for future ownership.

muselesscreator avatar May 11 '22 17:05 muselesscreator

Following up on the previous offline discussions in Frontend/Paragon Working Groups, we decided we'd defer on considering a TextEditor component in Paragon, at least one that consumes TinyMCE (especially needing to support paid plugins).

That said, it may be interesting if Paragon one day supported its own custom text editor component that didn't rely on TinyMCE, but instead something like https://github.com/facebook/lexical.

As a result, I'm inclined to close the PR for now, though we'll definitely be considering whether a text editor makes sense on the long term roadmap for Paragon.

@connorhaugh If you disagree, please feel to re-open the issue πŸ˜„ Thanks!

adamstankiewicz avatar Jan 26 '23 23:01 adamstankiewicz