From 9af5d136a95cadd91c3212080bb060091ce3453d Mon Sep 17 00:00:00 2001
From: tulup-conner <conner@tulup.io>
Date: Sun, 31 Jul 2022 19:47:02 +0000
Subject: [PATCH] fix(component): display text only on Sidebar.Item tooltip
 (#315)

* fix(component): display text only on `Sidebar.Item` tooltip

When a `Sidebar` is collapsed, each item's text content is hidden. You hover over an item to see a
`Tooltip` with its text content. That isn't how it worked up until now.

resolve #258

* test(component): drop false-positive `Sidebar` tests

I don't think we can rely on a fake DOM environment to test hover states correctly. We should write
integration tests for `<Sidebar collapsed/>` behavior in `cypress`.
---
 src/lib/components/Flowbite/FlowbiteTheme.ts  |  1 -
 src/lib/components/Sidebar/Sidebar.spec.tsx   | 27 -----------------
 .../components/Sidebar/Sidebar.stories.tsx    |  2 +-
 src/lib/components/Sidebar/SidebarItem.tsx    | 30 +++++++++++--------
 src/lib/components/Sidebar/index.tsx          |  2 +-
 src/lib/theme/default.ts                      |  3 +-
 6 files changed, 20 insertions(+), 45 deletions(-)

diff --git a/src/lib/components/Flowbite/FlowbiteTheme.ts b/src/lib/components/Flowbite/FlowbiteTheme.ts
index 34b304c6b..873f5f96c 100644
--- a/src/lib/components/Flowbite/FlowbiteTheme.ts
+++ b/src/lib/components/Flowbite/FlowbiteTheme.ts
@@ -413,7 +413,6 @@ export interface FlowbiteTheme {
       };
       content: {
         base: string;
-        collapsed: string;
       };
       icon: {
         base: string;
diff --git a/src/lib/components/Sidebar/Sidebar.spec.tsx b/src/lib/components/Sidebar/Sidebar.spec.tsx
index b852b0d89..dc7e401c9 100644
--- a/src/lib/components/Sidebar/Sidebar.spec.tsx
+++ b/src/lib/components/Sidebar/Sidebar.spec.tsx
@@ -117,30 +117,6 @@ describe.concurrent('Components / Sidebar', () => {
         });
       });
 
-      describe('`Sidebar.Collapse` and `Sidebar.Item`', () => {
-        it('should display tooltip', () => {
-          const items = getSidebarItems(render(<TestSidebar collapsed />));
-
-          items.forEach((item) => {
-            expect(item.firstElementChild).toHaveAttribute('data-testid', 'tooltip-target');
-          });
-        });
-
-        it("shouldn't display text content", () => {
-          const items = getSidebarItemContents(render(<TestSidebar collapsed />));
-
-          items.forEach((item) => expect(item).toHaveClass('hidden'));
-        });
-      });
-
-      describe('`Sidebar.Item`', () => {
-        it("shouldn't display `label`", () => {
-          const labels = getSidebarLabels(render(<TestSidebar collapsed />));
-
-          labels.forEach((label) => expect(label).not.toBeVisible());
-        });
-      });
-
       describe('`Sidebar.Logo`', () => {
         it("shouldn't display text content", () => {
           const logo = getSidebarLogo(render(<TestSidebar collapsed />));
@@ -459,8 +435,5 @@ const getSidebarItems = ({ getAllByRole }: Pick<RenderResult, 'getAllByRole'>):
 const getSidebarItemsContainer = ({ getAllByTestId }: Pick<RenderResult, 'getAllByTestId'>): HTMLElement[] =>
   getAllByTestId('flowbite-sidebar-items');
 
-const getSidebarLabels = ({ queryAllByTestId }: Pick<RenderResult, 'queryAllByTestId'>): HTMLElement[] =>
-  queryAllByTestId('flowbite-sidebar-label');
-
 const getSidebarLogo = ({ getByLabelText }: Pick<RenderResult, 'getByLabelText'>): HTMLElement =>
   getByLabelText('Flowbite');
diff --git a/src/lib/components/Sidebar/Sidebar.stories.tsx b/src/lib/components/Sidebar/Sidebar.stories.tsx
index a5d16510a..32e05a330 100644
--- a/src/lib/components/Sidebar/Sidebar.stories.tsx
+++ b/src/lib/components/Sidebar/Sidebar.stories.tsx
@@ -184,7 +184,7 @@ CTAButton.args = {
       </Sidebar.Items>
       <Sidebar.CTA>
         <div className="mb-3 flex items-center">
-          <Badge color="yellow">Beta</Badge>
+          <Badge color="warning">Beta</Badge>
           <div className="-m-1.5 ml-auto">
             <Button aria-label="Close" outline>
               <svg className="h-4 w-4" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
diff --git a/src/lib/components/Sidebar/SidebarItem.tsx b/src/lib/components/Sidebar/SidebarItem.tsx
index 62c2df80c..42c331626 100644
--- a/src/lib/components/Sidebar/SidebarItem.tsx
+++ b/src/lib/components/Sidebar/SidebarItem.tsx
@@ -32,7 +32,7 @@ const SidebarItem: FC<SidebarItemProps> = ({
   label,
   labelColor = 'info',
   ...props
-}): JSX.Element => {
+}) => {
   const theirProps = excludeClassName(props);
 
   const id = useId();
@@ -40,18 +40,28 @@ const SidebarItem: FC<SidebarItemProps> = ({
   const { isInsideCollapse } = useSidebarItemContext();
   const theme = useTheme().theme.sidebar.item;
 
-  const Wrapper: FC<PropsWithChildren<unknown>> = ({ children }): JSX.Element => (
+  const Wrapper: FC<PropsWithChildren<unknown>> = ({ children: Component }) => (
     <li>
       {isCollapsed ? (
-        <Tooltip content={children} placement="right">
-          {children}
+        <Tooltip content={<Children>{children}</Children>} placement="right">
+          {Component}
         </Tooltip>
       ) : (
-        children
+        Component
       )}
     </li>
   );
 
+  const Children: FC<PropsWithChildren<unknown>> = ({ children }) => (
+    <span
+      className={classNames(theme.content.base)}
+      data-testid="flowbite-sidebar-item-content"
+      id={`flowbite-sidebar-item-${id}`}
+    >
+      {children}
+    </span>
+  );
+
   return (
     <Wrapper>
       <Component
@@ -70,14 +80,8 @@ const SidebarItem: FC<SidebarItemProps> = ({
             data-testid="flowbite-sidebar-item-icon"
           />
         )}
-        <span
-          className={classNames(theme.content.base, isCollapsed && theme.content.collapsed)}
-          data-testid="flowbite-sidebar-item-content"
-          id={`flowbite-sidebar-item-${id}`}
-        >
-          {children}
-        </span>
-        {label && (
+        {!isCollapsed && <Children>{children}</Children>}
+        {label && !isCollapsed && (
           <Badge color={labelColor} data-testid="flowbite-sidebar-label" hidden={isCollapsed}>
             {label}
           </Badge>
diff --git a/src/lib/components/Sidebar/index.tsx b/src/lib/components/Sidebar/index.tsx
index be33f188e..5d9f065a9 100644
--- a/src/lib/components/Sidebar/index.tsx
+++ b/src/lib/components/Sidebar/index.tsx
@@ -1,5 +1,5 @@
 import classNames from 'classnames';
-import type { ComponentProps, FC, PropsWithChildren } from 'react';
+import { ComponentProps, FC, PropsWithChildren } from 'react';
 import { excludeClassName } from '../../helpers/exclude';
 import { useTheme } from '../Flowbite/ThemeContext';
 import SidebarCollapse from './SidebarCollapse';
diff --git a/src/lib/theme/default.ts b/src/lib/theme/default.ts
index 083aac5e9..505b18dec 100644
--- a/src/lib/theme/default.ts
+++ b/src/lib/theme/default.ts
@@ -697,8 +697,7 @@ export default {
         insideCollapse: 'group w-full pl-8 transition duration-75',
       },
       content: {
-        base: 'ml-3 flex-1 whitespace-nowrap',
-        collapsed: 'hidden',
+        base: 'px-3 flex-1 whitespace-nowrap',
       },
       icon: {
         base: 'h-6 w-6 flex-shrink-0 text-gray-500 transition duration-75 group-hover:text-gray-900 dark:text-gray-400 dark:group-hover:text-white',