Skip to content
This repository has been archived by the owner on Jan 9, 2023. It is now read-only.

Rich Text Editor #29

Closed
jackcmeyer opened this issue Sep 14, 2019 · 10 comments 路 Fixed by #93
Closed

Rich Text Editor #29

jackcmeyer opened this issue Sep 14, 2019 · 10 comments 路 Fixed by #93
Assignees
Labels
Projects
Milestone

Comments

@jackcmeyer
Copy link
Member

馃殌 Feature Proposal

Add a rich text editor as a component.

Motivation

Rich text editors are used when there is a need for formatted text content.

Example

Patient Notes

Relevant Links

@jackcmeyer jackcmeyer added enhancement New feature or request help wanted Extra attention is needed labels Sep 14, 2019
@jackcmeyer jackcmeyer added this to To do in Version 2.0 via automation Sep 14, 2019
@fox1t fox1t mentioned this issue Sep 14, 2019
20 tasks
@matteovivona matteovivona modified the milestones: v0.1.6, v0.2.0 Sep 16, 2019
@danielbollom
Copy link
Contributor

I'd be happy to start working on this component if it's still open?

I was thinking TinyMCE might be the best option to wrap - it's the lightest in terms of bundle size of the options above, and has a fairly extensive API to get what we need from it :)

@jackcmeyer
Copy link
Member Author

jackcmeyer commented Oct 16, 2019

@danielbollom the issues is all yours! I've assigned the issue to you.

I look forward to reviewing the pull request!

@fox1t
Copy link
Member

fox1t commented Oct 16, 2019

I agree that TinyMCE is the best choice for us. In its last version, it is easy to use and powerful enough to handle all of the our use cases.

@jackcmeyer jackcmeyer added in progress and removed help wanted Extra attention is needed labels Oct 17, 2019
@danielbollom
Copy link
Contributor

Hey guys! I was working on this one earlier and I was wondering which functionality/plugins would be required for the editor?

I was thinking:

  • undo/redo
  • font size/style
  • heading/paragraph formatting
  • bold/italic/underline text
  • sub/super text
  • highlight text
  • text align (right, left, centre, justify)
  • list (bullets, numbered)
  • indent/outdent
  • image embed
  • table
  • link
  • special characters

Is there anything else that would be useful to include?

The list of TinyMCE plugins is here: https://www.tiny.cloud/docs-3x/reference/TinyMCE3x@Plugins/

And the list of buttons/controls is here: https://www.tiny.cloud/docs-3x/reference/buttons/

@jackcmeyer
Copy link
Member Author

@danielbollom I think this is a sufficient list of features for now!

@fox1t
Copy link
Member

fox1t commented Oct 20, 2019

I want to point out that we need an extra care on image embed feature. We don't really want to allow our users to embed patient images, MRIs and so on. The software will have already a place to store patient images. I think it would be nice to let them "include" an image in text: however also this could be problematic, since the images will be stored encrypted using pub/priv keys.

@danielbollom
Copy link
Contributor

@fox1t the default behaviour for tinyMCE gives the user an option to include a link to an image which is sets as the source for an image tag in the output. Would this be okay, or will it be easier to remove the image functionality for the moment? It's very straightforward to include/exclude at a later point if required.

@fox1t
Copy link
Member

fox1t commented Oct 21, 2019

I think we can remove the image functionality for the moment. We will surely return to it in the near future. :)

@danielbollom
Copy link
Contributor

Sounds great! :) I should time to get a pull request ready for this one in a day or two 馃憤

@jackcmeyer jackcmeyer changed the title Rich Text Edtior Rich Text Editor Oct 31, 2019
danielbollom added a commit to danielbollom/components that referenced this issue Nov 18, 2019
Version 2.0 automation moved this from To do to Done Nov 21, 2019
ghost pushed a commit that referenced this issue Nov 21, 2019
# [0.18.0](v0.17.1...v0.18.0) (2019-11-21)

### Features

* **richtext:** adds RichText component ([d541c93](d541c93)), closes [#29](#29)
* **richtext:** fixes comments in Props to display in storybook ([fa1e526](fa1e526)), closes [#93](#93)
* **richtext:** fixes default value for disabled prop ([587a493](587a493)), closes [#93](#93)
@ghost
Copy link

ghost commented Nov 21, 2019

馃帀 This issue has been resolved in version 0.18.0 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

@ghost ghost added the released label Nov 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
Version 2.0
  
Done
Development

Successfully merging a pull request may close this issue.

4 participants