Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions site/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ import {
} from "react";
import { QueryClient, QueryClientProvider } from "react-query";
import { RouterProvider } from "react-router";
import { TooltipProvider } from "#/components/Tooltip/Tooltip";
import {
TOOLTIP_DELAY_DURATION,
TooltipProvider,
} from "#/components/Tooltip/Tooltip";
import { Toaster } from "./components/Toaster/Toaster";
import { AuthProvider } from "./contexts/auth/AuthProvider";
import { DiffsWorkerPoolProvider } from "./contexts/DiffsWorkerPoolProvider";
Expand Down Expand Up @@ -56,7 +59,7 @@ export const AppProviders: FC<AppProvidersProps> = ({
<DiffsWorkerPoolProvider>
<AuthProvider>
<ThemeProvider>
<TooltipProvider delayDuration={100}>
<TooltipProvider delayDuration={TOOLTIP_DELAY_DURATION}>
{children}
<Toaster />
</TooltipProvider>
Expand Down
2 changes: 1 addition & 1 deletion site/src/components/HelpPopover/HelpPopover.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type Size = "small" | "medium";

export const HelpPopoverTrigger = PopoverTrigger;

export const HelpPopoverIcon = CircleHelpIcon;
const HelpPopoverIcon = CircleHelpIcon;

export const HelpPopover = Popover;

Expand Down
69 changes: 46 additions & 23 deletions site/src/components/InfoTooltip/InfoTooltip.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,61 +1,84 @@
import type { Meta, StoryObj } from "@storybook/react-vite";
import { expect, screen, userEvent, waitFor } from "storybook/test";
import { Link } from "#/components/Link/Link";
import { TooltipMessage, TooltipTitle } from "#/components/Tooltip/Tooltip";
import { InfoTooltip } from "./InfoTooltip";

const meta = {
title: "components/InfoTooltip",
component: InfoTooltip,
args: {
type: "info",
title: "Hello, friend!",
message: "Today is a lovely day :^)",
children: (
<>
<TooltipTitle>Hello, friend!</TooltipTitle>
<TooltipMessage>Today is a lovely day :^)</TooltipMessage>
</>
),
},
} satisfies Meta<typeof InfoTooltip>;

export default meta;
type Story = StoryObj<typeof InfoTooltip>;

export const Example: Story = {
export const Info: Story = {
play: async ({ step }) => {
await step("activate hover trigger", async () => {
await userEvent.click(screen.getByRole("button"));
await step("hover trigger reveals content", async () => {
await userEvent.hover(screen.getByRole("button"));
await waitFor(() =>
expect(screen.getByRole("dialog")).toHaveTextContent(meta.args.message),
expect(screen.getByRole("tooltip")).toHaveTextContent(
"Today is a lovely day :^)",
),
);
});
},
};

export const Notice = {
export const Warning: Story = {
args: {
type: "notice",
message: "Unfortunately, there's a radio connected to my brain",
type: "warning",
children: (
<>
<TooltipTitle>Something needs attention</TooltipTitle>
<TooltipMessage>
Unfortunately, there's a radio connected to my brain
</TooltipMessage>
</>
),
},
play: async ({ step }) => {
await step("activate hover trigger", async () => {
await userEvent.click(screen.getByRole("button"));
await step("hover trigger reveals content", async () => {
await userEvent.hover(screen.getByRole("button"));
await waitFor(() =>
expect(screen.getByRole("dialog")).toHaveTextContent(
Notice.args.message,
expect(screen.getByRole("tooltip")).toHaveTextContent(
"Unfortunately, there's a radio connected to my brain",
),
);
});
},
} satisfies Story;
};

export const Warning = {
export const WithLink: Story = {
args: {
type: "warning",
message: "Unfortunately, there's a radio connected to my brain",
children: (
<>
<TooltipTitle>What is a role?</TooltipTitle>
<TooltipMessage>
Coder role-based access control (RBAC) provides fine-grained access
management. View our docs on how to use the available roles.
<Link size="sm" href="https://coder.com/docs">
User Roles
</Link>
</TooltipMessage>
</>
),
},
play: async ({ step }) => {
await step("activate hover trigger", async () => {
await userEvent.click(screen.getByRole("button"));
await step("hover trigger reveals content", async () => {
await userEvent.hover(screen.getByRole("button"));
await waitFor(() =>
expect(screen.getByRole("dialog")).toHaveTextContent(
Warning.args.message,
),
expect(screen.getByRole("tooltip")).toHaveTextContent("User Roles"),
);
});
},
} satisfies Story;
};
79 changes: 49 additions & 30 deletions site/src/components/InfoTooltip/InfoTooltip.tsx
Original file line number Diff line number Diff line change
@@ -1,47 +1,66 @@
import { cn } from "cn";
import { InfoIcon, TriangleAlertIcon } from "lucide-react";
import type { FC, ReactNode } from "react";
import {
HelpPopover,
HelpPopoverContent,
HelpPopoverIcon,
HelpPopoverIconTrigger,
HelpPopoverText,
HelpPopoverTitle,
} from "#/components/HelpPopover/HelpPopover";
import type { ThemeRole } from "#/theme/roles";
TOOLTIP_DELAY_DURATION,
Tooltip,
TooltipContent,
TooltipProvider,
TooltipTrigger,
} from "#/components/Tooltip/Tooltip";

type InfoTooltipType = "info" | "warning";

type InfoTooltipSize = "small" | "medium";

interface InfoTooltipProps {
type?: ThemeRole;
title?: ReactNode;
message: ReactNode;
type?: InfoTooltipType;
size?: InfoTooltipSize;
children: ReactNode;
}

const tooltipColorClasses: Record<ThemeRole, string> = {
const typeIcon: Record<InfoTooltipType, typeof InfoIcon> = {
info: InfoIcon,
warning: TriangleAlertIcon,
};

const typeIconColor: Record<InfoTooltipType, string> = {
info: "text-content-secondary",
error: "text-content-destructive",
warning: "text-content-warning",
notice: "text-content-link",
success: "text-content-success",
danger: "text-content-destructive",
active: "text-content-link",
inactive: "text-content-secondary",
preview: "text-highlight-purple",
};

const sizeClasses: Record<InfoTooltipSize, string> = {
small: "[&_svg]:size-3",
medium: "[&_svg]:size-4",
};

export const InfoTooltip: FC<InfoTooltipProps> = ({
title,
message,
children,
type = "info",
size = "medium",
}) => {
const Icon = typeIcon[type];

return (
<HelpPopover>
<HelpPopoverIconTrigger size="small" hoverEffect={false}>
<HelpPopoverIcon className={cn(tooltipColorClasses[type])} />
</HelpPopoverIconTrigger>
<HelpPopoverContent>
{title && <HelpPopoverTitle>{title}</HelpPopoverTitle>}
<HelpPopoverText>{message}</HelpPopoverText>
</HelpPopoverContent>
</HelpPopover>
<TooltipProvider delayDuration={TOOLTIP_DELAY_DURATION}>
<Tooltip>
<TooltipTrigger
type="button"
aria-label="More info"
className={cn(
"flex items-center justify-center p-0",
"border-0 border-none bg-transparent cursor-default",
"opacity-75 hover:opacity-100 transition-opacity",
sizeClasses[size],
typeIconColor[type],
)}
>
<Icon />
</TooltipTrigger>
<TooltipContent side="right" align="center" className="max-w-xs">
{children}
</TooltipContent>
</Tooltip>
</TooltipProvider>
);
};
26 changes: 26 additions & 0 deletions site/src/components/Tooltip/Tooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ import { Tooltip as TooltipPrimitive } from "radix-ui";

export const TooltipProvider = TooltipPrimitive.Provider;

/**
* Shared open delay (ms) for tooltips. Used by the app-wide provider and by
* self-contained tooltips such as InfoTooltip so hover timing stays consistent.
*/
export const TOOLTIP_DELAY_DURATION = 100;

export const Tooltip = TooltipPrimitive.Root;

export const TooltipTrigger = TooltipPrimitive.Trigger;
Expand Down Expand Up @@ -47,3 +53,23 @@ export const TooltipContent: React.FC<TooltipContentProps> = ({
<TooltipPrimitive.Portal>{content}</TooltipPrimitive.Portal>
);
};

export const TooltipTitle: React.FC<React.ComponentProps<"p">> = ({
className,
...props
}) => (
<p
className={cn("m-0 mb-1 font-semibold text-content-primary", className)}
{...props}
/>
);

export const TooltipMessage: React.FC<React.ComponentProps<"p">> = ({
className,
...props
}) => (
<p
className={cn("m-0 text-content-secondary [&_a]:mt-2", className)}
{...props}
/>
);
7 changes: 3 additions & 4 deletions site/src/pages/AIBridgePage/NetworkCallBadges.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,16 @@ export const TotalAndBlockedKeyboard: Story = {
},
};

// Tabbing to the disabled indicator's info button and pressing Enter reveals
// the reason popover without a mouse.
// Tabbing to the disabled indicator's info button reveals the reason tooltip
// without a mouse.
export const DisabledKeyboard: Story = {
args: {
summary: undefined,
},
play: async () => {
await userEvent.tab();
await userEvent.keyboard("{Enter}");
await waitFor(() =>
expect(screen.getByRole("dialog")).toHaveTextContent(
expect(screen.getByRole("tooltip")).toHaveTextContent(
"Network request monitoring was not active for this session.",
),
);
Expand Down
7 changes: 6 additions & 1 deletion site/src/pages/AIBridgePage/NetworkRequestStates.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { FC } from "react";
import { InfoTooltip } from "#/components/InfoTooltip/InfoTooltip";
import { TooltipMessage } from "#/components/Tooltip/Tooltip";

// Shared by the sessions list badges and the session detail summary card, which
// render the same two non-numeric states for a session's network requests but
Expand All @@ -8,7 +9,11 @@ import { InfoTooltip } from "#/components/InfoTooltip/InfoTooltip";
export const NetworkMonitoringDisabled: FC = () => (
<span className="inline-flex items-center gap-1 whitespace-nowrap text-content-secondary">
Disabled
<InfoTooltip message="Network request monitoring was not active for this session." />
<InfoTooltip>
<TooltipMessage>
Network request monitoring was not active for this session.
</TooltipMessage>
</InfoTooltip>
</span>
);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,18 +71,17 @@ export const NetworkDisabled: Story = {
},
};

// Tabbing to the disabled indicator's info button and pressing Enter reveals
// the reason without a mouse.
// Tabbing to the disabled indicator's info button reveals the reason tooltip
// without a mouse.
export const NetworkDisabledKeyboard: Story = {
args: {
...Default.args,
networkCalls: undefined,
},
play: async () => {
await userEvent.tab();
await userEvent.keyboard("{Enter}");
await waitFor(() =>
expect(screen.getByRole("dialog")).toHaveTextContent(
expect(screen.getByRole("tooltip")).toHaveTextContent(
"Network request monitoring was not active for this session.",
),
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { Button } from "#/components/Button/Button";
import { InfoTooltip } from "#/components/InfoTooltip/InfoTooltip";
import { TableCell } from "#/components/Table/Table";
import { TimelineEntry } from "#/components/Timeline/TimelineEntry";
import { TooltipMessage, TooltipTitle } from "#/components/Tooltip/Tooltip";
import { useAuthenticated } from "#/hooks/useAuthenticated";
import { useClickableTableRow } from "#/hooks/useClickableTableRow";

Expand Down Expand Up @@ -53,7 +54,10 @@ export const VersionRow: FC<VersionRowProps> = ({
version <strong>{version.name}</strong>
</span>
{version.message && (
<InfoTooltip title="Message" message={version.message} />
<InfoTooltip>
<TooltipTitle>Message</TooltipTitle>
<TooltipMessage>{version.message}</TooltipMessage>
</InfoTooltip>
)}
<span className="text-xs text-content-secondary">
{new Date(version.created_at).toLocaleTimeString()}
Expand Down
Loading