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

Add more advanced text editor for coaching notes #44

Conversation

jhodapp
Copy link
Member

@jhodapp jhodapp commented Oct 15, 2024

Description

This PR adds a new CoachingNotes and TipTapEditor pair of components to bring rich text editing into a coaching session.

GitHub Issue: #42

Changes

  • Adds a new TipTapEditor component which wraps the TipTap rich text editor
  • Enables a nice baseline of desirable rich text editing functionality
  • Stores coaching notes as a TipTap JSON document type
  • Moves CoachingNotes into a separate file and out of coaching session page.tsx
  • Adds Sass styling sheets for TipTap and its child components
  • Can use Tailwindcss tags and classes in Sass stylesheets

Screenshots / Videos Showing UI Changes

Jim __ Caleb _ Oct 14_ 2024

Testing Strategy

  1. Navigate to the coaching session page
  2. Start editing text in the coaching notes text area
  3. Exercise all text formatting options in the toolbar
  4. Also try toggling light/dark mode and ensure all elements remain visible
  5. Navigate away from this session and back into it
  6. Notice that the rich text formatting is restored on page load

Concerns

None

@jhodapp jhodapp added enhancement Improves existing functionality or feature feature work Specifically implementing a new feature labels Oct 15, 2024
@jhodapp jhodapp self-assigned this Oct 15, 2024
@jhodapp jhodapp added this to the 1.0-rc1 milestone Oct 16, 2024
@jhodapp jhodapp requested review from calebbourg and qafui October 18, 2024 17:36
@jhodapp jhodapp marked this pull request as ready for review October 18, 2024 17:37
src/lib/api/notes.ts Outdated Show resolved Hide resolved
Remove commented out line.
Copy link
Collaborator

@calebbourg calebbourg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was able to test that, from what I can tell, all existing features are working!

@jhodapp jhodapp merged commit 634705e into main Oct 18, 2024
1 check passed
@jhodapp jhodapp deleted the 42-feature-request-suggestion-integrate-a-more-advanced-text-editor-for-coaching-notes branch October 18, 2024 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improves existing functionality or feature feature work Specifically implementing a new feature
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

[Feature Request / Suggestion]: Integrate a more advanced text editor for coaching notes
2 participants