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 WYSIWYG Editor - Design System #529

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from

Conversation

g-saracca
Copy link
Contributor

@g-saracca g-saracca commented Oct 24, 2024

What this PR does / why we need it:

Adds a new Rich Text Editor component to the design system.

This component is made with Tiptap npm packages.
Tiptap is a headless wrapper around ProseMirror – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as New York Times, The Guardian or Atlassian.

Cons: It does not support markdown as output, the output is html.
Pros:

  • It does support Markdown shortcuts.
  • Compatible with what dataverse already handles for rich content, that is html.
  • Tiptap is headless, that means there is no styling provided so all styles were matched to what the rest of the SPA components look like.

Which issue(s) this PR closes:

Suggestions on how to test this:

Visual code inspection and Storybook story manual testing.
The component has 100% unit test coverage as well.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Screen Shot 2024-10-24 at 10 19 52 Screen Shot 2024-10-24 at 10 11 19

@g-saracca g-saracca added Size: 3 A percentage of a sprint. 2.1 hours. D: Design System Deliverable: Design System GREI Re-arch GREI re-architecture-related Original size: 3 SPA.Q4 Not related to any specific Q4 feature FY25 Sprint 9 FY25 Sprint 9 (2024-10-23 - 2024-11-06) labels Oct 24, 2024
@coveralls
Copy link

Coverage Status

coverage: 97.517% (+0.1%) from 97.385%
when pulling dee7698 on feat/525-rich-text-editor
into 02bc675 on develop.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D: Design System Deliverable: Design System FY25 Sprint 9 FY25 Sprint 9 (2024-10-23 - 2024-11-06) GREI Re-arch GREI re-architecture-related Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q4 Not related to any specific Q4 feature
Projects
Status: Ready for Review ⏩
Development

Successfully merging this pull request may close these issues.

Rich Text WYSIWYG Editor - Design System
2 participants