Truncated text component (#1117)

yashgoyal0110 · kasya · arkid15r · web-flow · commit ec54a5f6166f · 2025-03-24T21:38:52.000Z
* commit

* Update pnpm-lock.yaml

* Update vite.config.ts

* Update package.json

* truncate text component

* commit

* commit

* commit

* commit

* commit

* commit

* commit

* commit

* commit

* commit

* fixed e2e and improved truncate component

* fixed pre-commit

* comit

* comit

* commit

* fixed unit tests

* fixed unit test

* commit

* Update code

---------

Co-authored-by: Kate Golovanova &lt;kate@kgthreads.com&gt;
Co-authored-by: Arkadii Yakovets &lt;2201626+arkid15r@users.noreply.github.com&gt;
Co-authored-by: Arkadii Yakovets &lt;arkadii.yakovets@owasp.org&gt;
diff --git a/frontend/__tests__/e2e/pages/Home.spec.ts b/frontend/__tests__/e2e/pages/Home.spec.ts
@@ -84,4 +84,15 @@ test.describe('Home Page', () => {
     await expect(page.getByText('Feb 27 — 28, 2025')).toBeVisible()
     await page.getByRole('button', { name: 'Event 1' }).click()
   })
+
+  test('should have truncated text with overflow for all relevant elements', async ({ page }) => {
+    const truncatedElements = await page.locator('span.truncate').all()
+    expect(truncatedElements.length).toBeGreaterThan(0)
+
+    for (const element of truncatedElements) {
+      await expect(element).toHaveCSS('overflow', 'hidden')
+      await expect(element).toHaveCSS('text-overflow', 'ellipsis')
+      await expect(element).toHaveCSS('white-space', 'nowrap')
+    }
+  })
 })
diff --git a/frontend/__tests__/unit/components/TruncatedText.test.tsx b/frontend/__tests__/unit/components/TruncatedText.test.tsx
@@ -0,0 +1,30 @@
+import { render, screen } from 'wrappers/testUtil'
+import { TruncatedText } from 'components/TruncatedText'
+
+describe('TruncatedText Component', () => {
+  const longText = 'This is very long text that should be truncated for display.'
+
+  test('renders full text when it fits within the container', () => {
+    render(<TruncatedText text="Short text" className="w-auto" />)
+    const textElement = screen.getByText('Short text')
+    expect(textElement).toBeInTheDocument()
+    expect(textElement).toHaveAttribute('title', 'Short text')
+  })
+
+  test('truncates text when it exceeds container width', () => {
+    render(
+      <div style={{ width: '100px' }}>
+        <TruncatedText text={longText} />
+      </div>
+    )
+    const textElement = screen.getByText(longText)
+    expect(textElement).toHaveClass('truncate')
+    expect(textElement).toHaveClass('text-ellipsis')
+  })
+
+  test('title attribute is always present', () => {
+    render(<TruncatedText text={longText} />)
+    const textElement = screen.getByText(longText)
+    expect(textElement).toHaveAttribute('title', longText)
+  })
+})
diff --git a/frontend/jest.setup.ts b/frontend/jest.setup.ts
@@ -13,7 +13,6 @@ if (!global.structuredClone) {
   global.structuredClone = (val) => JSON.parse(JSON.stringify(val))
 }
 
-// mock runAnimationFrameCallbacks function for testing
 beforeAll(() => {
   if (typeof window !== 'undefined') {
     jest.spyOn(window, 'requestAnimationFrame').mockImplementation((cb) => {
@@ -22,10 +21,16 @@ beforeAll(() => {
 
     Object.defineProperty(window, 'runAnimationFrameCallbacks', {
       value: () => {},
-      writable: true,
       configurable: true,
+      writable: true,
     })
   }
+
+  global.ResizeObserver = class {
+    disconnect() {}
+    observe() {}
+    unobserve() {}
+  }
 })
 
 beforeEach(() => {
diff --git a/frontend/src/components/ItemCardList.tsx b/frontend/src/components/ItemCardList.tsx
@@ -2,6 +2,7 @@ import { JSX } from 'react'
 import { ProjectIssuesType, ProjectReleaseType } from 'types/project'
 import { PullRequestsType } from 'types/user'
 import SecondaryCard from './SecondaryCard'
+import { TruncatedText } from './TruncatedText'
 
 const ItemCardList = ({
   title,
@@ -44,7 +45,7 @@ const ItemCardList = ({
                     href={item?.url}
                     target="_blank"
                   >
-                    {item.title || item.name}
+                    <TruncatedText text={item.title || item.name} />
                   </a>
                 </h3>
               </div>
diff --git a/frontend/src/components/RepositoriesCard.tsx b/frontend/src/components/RepositoriesCard.tsx
@@ -13,6 +13,7 @@ import type React from 'react'
 import { useState } from 'react'
 import { useNavigate } from 'react-router-dom'
 import { RepositoriesCardProps } from 'types/project'
+import { TruncatedText } from './TruncatedText'
 
 const RepositoriesCard: React.FC<RepositoriesCardProps> = ({ repositories }) => {
   const [showAllRepositories, setShowAllRepositories] = useState(false)
@@ -59,7 +60,7 @@ const RepositoryItem = ({ details }) => {
         onClick={handleClick}
         className="text-start font-semibold text-blue-500 hover:underline dark:text-blue-400"
       >
-        {details?.name}
+        <TruncatedText text={details?.name} />
       </button>
 
       <div className="space-y-2 text-sm">
diff --git a/frontend/src/components/TruncatedText.tsx b/frontend/src/components/TruncatedText.tsx
@@ -0,0 +1,37 @@
+import { useRef, useEffect, useCallback } from 'react'
+
+export const TruncatedText = ({ text, className = '' }: { text: string; className?: string }) => {
+  const textRef = useRef<HTMLSpanElement>(null)
+
+  const checkTruncation = useCallback(() => {
+    const element = textRef.current
+    if (element) {
+      element.title = text
+    }
+  }, [text])
+
+  useEffect(() => {
+    checkTruncation()
+
+    const observer = new ResizeObserver(() => checkTruncation())
+    if (textRef.current) {
+      observer.observe(textRef.current)
+    }
+
+    window.addEventListener('resize', checkTruncation)
+
+    return () => {
+      observer.disconnect()
+      window.removeEventListener('resize', checkTruncation)
+    }
+  }, [text, checkTruncation])
+
+  return (
+    <span
+      ref={textRef}
+      className={`block overflow-hidden truncate text-ellipsis whitespace-nowrap ${className}`}
+    >
+      {text}
+    </span>
+  )
+}
diff --git a/frontend/src/pages/Home.tsx b/frontend/src/pages/Home.tsx
@@ -29,6 +29,7 @@ import Modal from 'components/Modal'
 import MultiSearchBar from 'components/MultiSearch'
 import SecondaryCard from 'components/SecondaryCard'
 import TopContributors from 'components/ToggleContributors'
+import { TruncatedText } from 'components/TruncatedText'
 import { toaster } from 'components/ui/toaster'
 
 export default function Home() {
@@ -135,16 +136,16 @@ export default function Home() {
             />
           </div>
         </div>
-        <SecondaryCard title="Upcoming Events">
+        <SecondaryCard title="Upcoming Events" className="overflow-hidden">
           <div className="grid gap-4 sm:grid-cols-1 md:grid-cols-2 lg:grid-cols-3">
             {data.upcomingEvents.map((event: EventType, index: number) => (
-              <div key={`card-${event.name}`}>
+              <div key={`card-${event.name}`} className="overflow-hidden">
                 <div className="rounded-lg bg-gray-200 p-4 dark:bg-gray-700">
                   <button
                     className="mb-2 w-full text-left text-lg font-semibold text-blue-500 hover:underline"
                     onClick={() => setModalOpenIndex(index)}
                   >
-                    <h3 className="truncate text-wrap md:text-nowrap">{event.name}</h3>
+                    <TruncatedText text={event.name} />
                   </button>
                   <div className="flex flex-col flex-wrap items-start text-sm text-gray-600 dark:text-gray-300 md:flex-row">
                     <div className="mr-2 flex items-center">
@@ -173,13 +174,13 @@ export default function Home() {
           </div>
         </SecondaryCard>
         <div className="grid gap-4 md:grid-cols-2">
-          <SecondaryCard title="New Chapters">
+          <SecondaryCard title="New Chapters" className="overflow-hidden">
             <div className="space-y-4">
               {data.recentChapters.map((chapter) => (
                 <div key={chapter.key} className="rounded-lg bg-gray-200 p-4 dark:bg-gray-700">
                   <h3 className="mb-2 text-lg font-semibold">
                     <a href={`/chapters/${chapter.key}`} className="hover:underline">
-                      {chapter.name}
+                      <TruncatedText text={chapter.name} />
                     </a>
                   </h3>
                   <div className="flex flex-wrap items-center text-sm text-gray-600 dark:text-gray-300">
@@ -202,15 +203,15 @@ export default function Home() {
               ))}
             </div>
           </SecondaryCard>
-          <SecondaryCard title="New Projects">
+          <SecondaryCard title="New Projects" className="overflow-hidden">
             <div className="space-y-4">
               {data.recentProjects.map((project) => (
                 <div key={project.key} className="rounded-lg bg-gray-200 p-4 dark:bg-gray-700">
-                  <h3 className="mb-2 text-lg font-semibold">
-                    <a href={`/projects/${project.key}`} className="hover:underline">
-                      {project.name}
-                    </a>
-                  </h3>
+                  <a href={`/projects/${project.key}`} className="hover:underline">
+                    <h3 className="mb-2 truncate text-wrap text-lg font-semibold md:text-nowrap">
+                      <TruncatedText text={project.name} />
+                    </h3>
+                  </a>
                   <div className="flex flex-wrap items-center text-sm text-gray-600 dark:text-gray-300">
                     <div className="mr-4 flex items-center">
                       <FontAwesomeIcon icon={faCalendar} className="mr-2 h-4 w-4" />
@@ -280,22 +281,22 @@ export default function Home() {
             )}
           />
         </div>
-        <SecondaryCard title="Recent News & Opinions">
+        <SecondaryCard title="Recent News & Opinions" className="overflow-hidden">
           <div className="grid gap-4 sm:grid-cols-1 md:grid-cols-2">
             {data.recentPosts.map((post) => (
               <div
                 key={post.title}
-                className="rounded-lg bg-gray-200 p-4 dark:bg-gray-700"
+                className="overflow-hidden rounded-lg bg-gray-200 p-4 dark:bg-gray-700"
                 data-testid="post-container"
               >
-                <h3 className="mb-1 truncate text-wrap text-lg font-semibold text-blue-500 md:text-nowrap">
+                <h3 className="mb-1 text-lg font-semibold">
                   <a
                     href={post.url}
-                    className="hover:underline"
+                    className="text-blue-500 hover:underline"
                     target="_blank"
                     rel="noopener noreferrer"
                   >
-                    {post.title}
+                    <TruncatedText text={post.title} />
                   </a>
                 </h3>
                 <div className="mt-2 flex flex-col flex-wrap items-start text-sm text-gray-600 dark:text-gray-300 md:flex-row">
