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.

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

Rich Text Editor component #794

Closed
nate-ni opened this issue Oct 20, 2022 · 3 comments
Closed

Rich Text Editor component #794

nate-ni opened this issue Oct 20, 2022 · 3 comments
Labels
client request Client team would immediately benefit from this change new component Request for a new component

Comments

@nate-ni
Copy link
Contributor

nate-ni commented Oct 20, 2022

😯 Problem to Solve

A high-order component for allowing the user a consistent way to create and edit rich text.

💁 Proposed Solution

Could be MarkDown, a flavor of MarkDown or a different format for rich text.
Depending on user needs, something WYSIWYG may be more appropriate.
Needs to support @mentions

Some example technologies out there:

Quill - https://github.com/quilljs/quil

Quill is an example of a, non-markdown, technology but appears to no longer be maintained.

TipTap - https://github.com/ueberdosis/tiptap

TIpTap is a headless editor framework.

📋 Tasks

@nate-ni nate-ni added enhancement New feature or request triage New issue that needs to be reviewed client request Client team would immediately benefit from this change labels Oct 20, 2022
@rajsite
Copy link
Member

rajsite commented Oct 20, 2022

Some research I'd done for RichText for WebVIs, it's a couple years old but the concepts are relevant https://github.com/rajsite/webvi-experiments/tree/main/RichText#rich-text-for-webvis

@jattasNI jattasNI added new component Request for a new component and removed enhancement New feature or request triage New issue that needs to be reviewed labels Oct 25, 2022
@prestwick
Copy link

FYI, a component with this capability came up in the context of the comments feature the LIMS teams may be prioritizing.

@jattasNI
Copy link
Contributor

jattasNI commented Jun 8, 2023

Closing this issue in favor of #1288

@jattasNI jattasNI closed this as not planned Won't fix, can't repro, duplicate, stale Jun 8, 2023
jattasNI added a commit that referenced this issue Jun 20, 2023
…ges (#1301)

# Pull Request

## 🤨 Rationale

Rick created these icons for #794 and reached out to me directly to
integrate them into Nimble.

## 👩‍💻 Implementation

Followed the process in nimble-tokens CONTRIBUTING
- the default icon names generated from Rick's file names seemed good
enough to me. Font Awesome calls their "B" and "I" icons "bold" and
"italic" too.
- had to manually remove a fill from one of the icons so that severity
colors would be applied. I asked Rick to make a similar change in
Illustrator

Also noticed that the icon metadata file was only used for tests, so
moved it to a tests location.

## 🧪 Testing

Manual inspection of Storybook.

Chromatic [didn't initially detect any icon
changes](https://www.chromatic.com/build?appId=60e89457a987cf003efc0a5b&number=6026)
because [TurboSnap](https://www.chromatic.com/docs/turbosnap) didn't
notice that any dependencies of the icon story had changed. I added
Chromatic `externals` configuration to the GitHub Actions configuration
to include icon and token source files in their diff calculation, [as
described in Chromatic
docs](https://www.chromatic.com/docs/turbosnap#specify-external-files-to-trigger-a-full-re-test-when-they-change).

## ✅ Checklist

<!--- Review the list and put an x in the boxes that apply or ~~strike
through~~ around items that don't (along with an explanation). -->

- [x] I have updated the project documentation to reflect my changes or
determined no changes are needed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client request Client team would immediately benefit from this change new component Request for a new component
Projects
Development

No branches or pull requests

4 participants