-
Notifications
You must be signed in to change notification settings - Fork 95
feat: add torph text morphing animations #278
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
Draft
paulbalaji
wants to merge
7
commits into
main
Choose a base branch
from
feat/torph-text-animations
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9bcdae4
feat(ui): add torph@0.0.5 and jest-environment-jsdom for testing
paulbalaji 30cd462
feat(ui): add SafeTextMorph wrapper component with ErrorBoundary
paulbalaji 216acce
feat(ui): wrap dynamic text displays with SafeTextMorph animations
paulbalaji 02f1b52
test: add SafeTextMorph smoke tests
paulbalaji 415b1cb
fix(ui): avoid wrapping static 'Status' text in SafeTextMorph
paulbalaji bf9b657
fix: address torph review feedback and tooling mismatches
paulbalaji 7f15cb2
chore: apply prettier formatting
paulbalaji File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /** | ||
| * @jest-environment jsdom | ||
| */ | ||
| import { act } from 'react'; | ||
| import { createRoot } from 'react-dom/client'; | ||
|
|
||
| import { SafeTextMorph } from './SafeTextMorph'; | ||
|
|
||
| globalThis.IS_REACT_ACT_ENVIRONMENT = true; | ||
|
|
||
| let shouldThrow = false; | ||
|
|
||
| jest.mock('torph/react', () => ({ | ||
| TextMorph: ({ children, as: Tag = 'span', ...props }: any) => { | ||
| if (shouldThrow) { | ||
| throw new Error('TextMorph animation error'); | ||
| } | ||
| // eslint-disable-next-line @typescript-eslint/no-require-imports | ||
| const ReactLib = require('react'); | ||
| return ReactLib.createElement(Tag, props, children); | ||
| }, | ||
| })); | ||
|
|
||
| let container: HTMLDivElement; | ||
| let root: ReturnType<typeof createRoot>; | ||
|
|
||
| beforeEach(() => { | ||
| shouldThrow = false; | ||
| container = document.createElement('div'); | ||
| document.body.appendChild(container); | ||
| root = createRoot(container); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| act(() => { | ||
| root.unmount(); | ||
| }); | ||
| container.remove(); | ||
| }); | ||
|
|
||
| describe('SafeTextMorph', () => { | ||
| it('renders children string correctly', () => { | ||
| act(() => { | ||
| root.render(<SafeTextMorph>Hello World</SafeTextMorph>); | ||
| }); | ||
| expect(container.textContent).toBe('Hello World'); | ||
| }); | ||
|
|
||
| it('renders fallback when TextMorph throws', () => { | ||
| const consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => {}); | ||
| shouldThrow = true; | ||
|
|
||
| act(() => { | ||
| root.render(<SafeTextMorph>Fallback Text</SafeTextMorph>); | ||
| }); | ||
|
|
||
| expect(container.textContent).toBe('Fallback Text'); | ||
| const span = container.querySelector('span'); | ||
| expect(span).not.toBeNull(); | ||
| expect(consoleSpy).toHaveBeenCalledWith('TextMorph error:', expect.any(Error)); | ||
|
|
||
| consoleSpy.mockRestore(); | ||
| }); | ||
|
|
||
| it('handles empty string', () => { | ||
| act(() => { | ||
| root.render(<SafeTextMorph>{''}</SafeTextMorph>); | ||
| }); | ||
| expect(container.textContent).toBe(''); | ||
| }); | ||
|
|
||
| it('coerces number to string', () => { | ||
| act(() => { | ||
| root.render(<SafeTextMorph>{42}</SafeTextMorph>); | ||
| }); | ||
| expect(container.textContent).toBe('42'); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| 'use client'; | ||
|
|
||
| import React, { type CSSProperties, type ReactNode } from 'react'; | ||
| import { TextMorph } from 'torph/react'; | ||
|
|
||
| type TextMorphErrorBoundaryProps = { | ||
| children: ReactNode; | ||
| fallbackText: string; | ||
| as: keyof JSX.IntrinsicElements; | ||
| className?: string; | ||
| style?: CSSProperties; | ||
| }; | ||
|
|
||
| class TextMorphErrorBoundary extends React.Component< | ||
| TextMorphErrorBoundaryProps, | ||
| { hasError: boolean } | ||
| > { | ||
| constructor(props: TextMorphErrorBoundaryProps) { | ||
| super(props); | ||
| this.state = { hasError: false }; | ||
| } | ||
|
|
||
| static getDerivedStateFromError() { | ||
| return { hasError: true }; | ||
| } | ||
|
|
||
| componentDidCatch(error: Error) { | ||
| // eslint-disable-next-line no-console | ||
| console.error('TextMorph error:', error); | ||
| } | ||
|
|
||
| componentDidUpdate(prevProps: TextMorphErrorBoundaryProps) { | ||
| if ( | ||
| this.state.hasError && | ||
| (prevProps.fallbackText !== this.props.fallbackText || | ||
| prevProps.as !== this.props.as || | ||
| prevProps.className !== this.props.className || | ||
| prevProps.style !== this.props.style) | ||
| ) { | ||
| this.setState({ hasError: false }); | ||
| } | ||
| } | ||
|
|
||
| render() { | ||
| if (this.state.hasError) { | ||
| const { as: Tag, className, style, fallbackText } = this.props; | ||
| return React.createElement(Tag, { className, style }, fallbackText); | ||
| } | ||
| return this.props.children; | ||
| } | ||
| } | ||
|
|
||
| interface SafeTextMorphProps { | ||
| children: string | number | boolean | null | undefined; | ||
| as?: keyof JSX.IntrinsicElements; | ||
| className?: string; | ||
| style?: CSSProperties; | ||
| duration?: number; | ||
| } | ||
|
|
||
| export function SafeTextMorph({ | ||
| children, | ||
| as = 'span', | ||
| className, | ||
| style, | ||
| duration, | ||
| }: SafeTextMorphProps) { | ||
| const textContent = String(children ?? ''); | ||
|
|
||
| return ( | ||
| <TextMorphErrorBoundary fallbackText={textContent} as={as} className={className} style={style}> | ||
| <TextMorph as={as} className={className} style={style} duration={duration}> | ||
| {textContent} | ||
| </TextMorph> | ||
| </TextMorphErrorBoundary> | ||
| ); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.