Skip to content

Commit a6461ab

Browse files
author
Bruno Quaresma
authored
feat: improve template version select ux (coder#20347)
**Improvements:** - Sort by creation date DESC - Show which version is active - Add tooltip **Demo:** https://github.com/user-attachments/assets/1030c8a6-870f-42f0-be97-87c9f3392d3f Close coder/internal#1057
1 parent 838fbc1 commit a6461ab

6 files changed

Lines changed: 238 additions & 52 deletions

File tree

‎site/src/components/Select/Select.tsx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ export const SelectGroup = SelectPrimitive.Group;
1313

1414
export const SelectValue = SelectPrimitive.Value;
1515

16+
export type SelectTriggerProps = React.ComponentPropsWithoutRef<
17+
typeof SelectPrimitive.Trigger
18+
>;
19+
1620
export const SelectTrigger = React.forwardRef<
1721
React.ElementRef<typeof SelectPrimitive.Trigger>,
18-
React.ComponentPropsWithoutRef<typeof SelectPrimitive.Trigger> & {
19-
id?: string;
20-
}
22+
SelectTriggerProps
2123
>(({ className, children, id, ...props }, ref) => (
2224
<SelectPrimitive.Trigger
2325
ref={ref}
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import type { Meta, StoryObj } from "@storybook/react-vite";
2+
import { Select, SelectContent, SelectItem } from "components/Select/Select";
3+
import { userEvent, within } from "storybook/test";
4+
import { PromptSelectTrigger } from "./PromptSelectTrigger";
5+
6+
const meta: Meta<typeof PromptSelectTrigger> = {
7+
title: "modules/tasks/TaskPrompt/PromptSelectTrigger",
8+
component: PromptSelectTrigger,
9+
args: {
10+
children: "Select a version",
11+
tooltip: "Template version",
12+
},
13+
render: (args) => (
14+
<Select>
15+
<PromptSelectTrigger {...args} />
16+
<SelectContent>
17+
<SelectItem value="version-1">Version 1</SelectItem>
18+
<SelectItem value="version-2">Version 2</SelectItem>
19+
<SelectItem value="version-3">Version 3</SelectItem>
20+
</SelectContent>
21+
</Select>
22+
),
23+
};
24+
25+
export default meta;
26+
type Story = StoryObj<typeof PromptSelectTrigger>;
27+
28+
export const Closed: Story = {};
29+
30+
export const Open: Story = {
31+
play: async ({ canvasElement }) => {
32+
const canvas = within(canvasElement);
33+
const trigger = canvas.getByRole("combobox");
34+
await userEvent.click(trigger);
35+
},
36+
};
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
import {
2+
SelectTrigger,
3+
type SelectTriggerProps,
4+
} from "components/Select/Select";
5+
import {
6+
Tooltip,
7+
TooltipContent,
8+
TooltipProvider,
9+
TooltipTrigger,
10+
} from "components/Tooltip/Tooltip";
11+
import type { FC } from "react";
12+
import { cn } from "utils/cn";
13+
14+
type PromptSelectTriggerProps = SelectTriggerProps & {
15+
tooltip: string;
16+
};
17+
18+
export const PromptSelectTrigger: FC<PromptSelectTriggerProps> = ({
19+
className,
20+
tooltip,
21+
...props
22+
}) => {
23+
return (
24+
<TooltipProvider>
25+
<Tooltip>
26+
<TooltipTrigger asChild>
27+
<SelectTrigger
28+
{...props}
29+
className={cn([
30+
className,
31+
`w-auto border-0 bg-surface-secondary text-sm text-content-primary gap-2 px-3
32+
[&_svg]:text-inherit cursor-pointer hover:bg-surface-quaternary rounded-full
33+
h-8 data-[state=open]:bg-surface-tertiary`,
34+
])}
35+
/>
36+
</TooltipTrigger>
37+
<TooltipContent>{tooltip}</TooltipContent>
38+
</Tooltip>
39+
</TooltipProvider>
40+
);
41+
};

‎site/src/modules/tasks/TaskPrompt/TaskPrompt.tsx‎

Lines changed: 11 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
import type { SelectTriggerProps } from "@radix-ui/react-select";
21
import { API } from "api/api";
32
import { getErrorDetail, getErrorMessage } from "api/errors";
4-
import {
5-
templateVersionPresets,
6-
templateVersions,
7-
} from "api/queries/templates";
3+
import { templateVersionPresets } from "api/queries/templates";
84
import type {
95
Preset,
106
Task,
@@ -20,7 +16,6 @@ import {
2016
Select,
2117
SelectContent,
2218
SelectItem,
23-
SelectTrigger,
2419
SelectValue,
2520
} from "components/Select/Select";
2621
import { Skeleton } from "components/Skeleton/Skeleton";
@@ -40,8 +35,9 @@ import { useMutation, useQuery, useQueryClient } from "react-query";
4035
import TextareaAutosize, {
4136
type TextareaAutosizeProps,
4237
} from "react-textarea-autosize";
43-
import { cn } from "utils/cn";
4438
import { docs } from "utils/docs";
39+
import { PromptSelectTrigger } from "./PromptSelectTrigger";
40+
import { TemplateVersionSelect } from "./TemplateVersionSelect";
4541

4642
type TaskPromptProps = {
4743
templates: Template[] | undefined;
@@ -154,10 +150,6 @@ const CreateTaskForm: FC<CreateTaskFormProps> = ({ templates, onSuccess }) => {
154150
const [selectedVersionId, setSelectedVersionId] = useState(
155151
selectedTemplate.active_version_id,
156152
);
157-
const versionsQuery = useQuery({
158-
...templateVersions(selectedTemplate.id),
159-
enabled: permissions.updateTemplates,
160-
});
161153
useEffect(() => {
162154
setSelectedVersionId(selectedTemplate.active_version_id);
163155
}, [selectedTemplate]);
@@ -280,7 +272,7 @@ const CreateTaskForm: FC<CreateTaskFormProps> = ({ templates, onSuccess }) => {
280272
defaultValue={templates[0].id}
281273
required
282274
>
283-
<PromptSelectTrigger id="templateID">
275+
<PromptSelectTrigger id="templateID" tooltip="Template">
284276
<SelectValue placeholder="Select a template" />
285277
</PromptSelectTrigger>
286278
<SelectContent>
@@ -297,30 +289,17 @@ const CreateTaskForm: FC<CreateTaskFormProps> = ({ templates, onSuccess }) => {
297289
</Select>
298290
</div>
299291

300-
{versionsQuery.data && (
292+
{permissions.updateTemplates && (
301293
<div>
302294
<label htmlFor="versionId" className="sr-only">
303295
Template version
304296
</label>
305-
<Select
306-
name="versionId"
307-
onValueChange={(value) => setSelectedVersionId(value)}
297+
<TemplateVersionSelect
298+
templateId={selectedTemplateId}
299+
activeVersionId={selectedTemplate.active_version_id}
308300
value={selectedVersionId}
309-
required
310-
>
311-
<PromptSelectTrigger id="versionId">
312-
<SelectValue placeholder="Select a version" />
313-
</PromptSelectTrigger>
314-
<SelectContent>
315-
{versionsQuery.data.map((version) => {
316-
return (
317-
<SelectItem value={version.id} key={version.id}>
318-
{version.name}
319-
</SelectItem>
320-
);
321-
})}
322-
</SelectContent>
323-
</Select>
301+
onValueChange={setSelectedVersionId}
302+
/>
324303
</div>
325304
)}
326305

@@ -340,7 +319,7 @@ const CreateTaskForm: FC<CreateTaskFormProps> = ({ templates, onSuccess }) => {
340319
value={selectedPresetId}
341320
onValueChange={setSelectedPresetId}
342321
>
343-
<PromptSelectTrigger id="presetID">
322+
<PromptSelectTrigger id="presetID" tooltip="Preset">
344323
<SelectValue placeholder="Select a preset" />
345324
</PromptSelectTrigger>
346325
<SelectContent>
@@ -390,23 +369,6 @@ const CreateTaskForm: FC<CreateTaskFormProps> = ({ templates, onSuccess }) => {
390369
);
391370
};
392371

393-
const PromptSelectTrigger: FC<SelectTriggerProps> = ({
394-
className,
395-
...props
396-
}) => {
397-
return (
398-
<SelectTrigger
399-
{...props}
400-
className={cn([
401-
className,
402-
`border-0 bg-surface-secondary text-sm text-content-primary gap-2 px-3
403-
[&_svg]:text-inherit cursor-pointer hover:bg-surface-quaternary rounded-full
404-
h-8 data-[state=open]:bg-surface-tertiary`,
405-
])}
406-
/>
407-
);
408-
};
409-
410372
type ExternalAuthButtonProps = {
411373
versionId: string;
412374
missedExternalAuth: TemplateVersionExternalAuth[];
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
import { MockTemplate, MockTemplateVersion } from "testHelpers/entities";
2+
import type { Meta, StoryObj } from "@storybook/react-vite";
3+
import { API } from "api/api";
4+
import { useState } from "react";
5+
import { spyOn, userEvent, within } from "storybook/test";
6+
import { daysAgo } from "utils/time";
7+
import { TemplateVersionSelect } from "./TemplateVersionSelect";
8+
9+
const meta: Meta<typeof TemplateVersionSelect> = {
10+
title: "modules/tasks/TaskPrompt/TemplateVersionSelect",
11+
component: TemplateVersionSelect,
12+
args: {
13+
activeVersionId: MockTemplateVersion.id,
14+
templateId: MockTemplate.id,
15+
value: MockTemplateVersion.id,
16+
},
17+
render: ({ value: defaultValue, ...args }) => {
18+
const [value, setValue] = useState(defaultValue);
19+
return (
20+
<TemplateVersionSelect {...args} value={value} onValueChange={setValue} />
21+
);
22+
},
23+
};
24+
25+
export default meta;
26+
type Story = StoryObj<typeof TemplateVersionSelect>;
27+
28+
const MockVersions = [
29+
{
30+
...MockTemplateVersion,
31+
id: "v1.0.0",
32+
name: "v1.0.0",
33+
created_at: daysAgo(3),
34+
},
35+
{
36+
...MockTemplateVersion,
37+
id: "v2.0.0",
38+
name: "v2.0.0",
39+
created_at: daysAgo(2),
40+
},
41+
{
42+
...MockTemplateVersion,
43+
id: "v3.0.0",
44+
name: "v3.0.0",
45+
created_at: daysAgo(1),
46+
},
47+
];
48+
49+
export const Loading: Story = {
50+
beforeEach: () => {
51+
spyOn(API, "getTemplateVersions").mockImplementation(() => {
52+
return new Promise(() => {});
53+
});
54+
},
55+
};
56+
57+
export const Loaded: Story = {
58+
args: {
59+
activeVersionId: MockVersions[2].id,
60+
value: MockVersions[2].id,
61+
},
62+
beforeEach: () => {
63+
spyOn(API, "getTemplateVersions").mockResolvedValue(MockVersions);
64+
},
65+
};
66+
67+
export const Open: Story = {
68+
args: {
69+
activeVersionId: MockVersions[2].id,
70+
value: MockVersions[2].id,
71+
},
72+
beforeEach: () => {
73+
spyOn(API, "getTemplateVersions").mockResolvedValue(MockVersions);
74+
},
75+
play: async ({ canvasElement }) => {
76+
const canvas = within(canvasElement);
77+
const trigger = await canvas.findByRole("combobox");
78+
await userEvent.click(trigger);
79+
},
80+
};
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
import { templateVersions } from "api/queries/templates";
2+
import { Badge } from "components/Badge/Badge";
3+
import {
4+
Select,
5+
SelectContent,
6+
SelectItem,
7+
SelectValue,
8+
} from "components/Select/Select";
9+
import { Skeleton } from "components/Skeleton/Skeleton";
10+
import type { FC } from "react";
11+
import { useQuery } from "react-query";
12+
import { PromptSelectTrigger } from "./PromptSelectTrigger";
13+
14+
type TemplateVersionSelectProps = {
15+
value: string;
16+
templateId: string;
17+
activeVersionId: string;
18+
onValueChange: (value: string) => void;
19+
};
20+
21+
export const TemplateVersionSelect: FC<TemplateVersionSelectProps> = ({
22+
templateId,
23+
activeVersionId,
24+
...props
25+
}) => {
26+
const { data: versions } = useQuery({
27+
...templateVersions(templateId),
28+
select: (versions) =>
29+
versions
30+
.filter((v) => !v.archived)
31+
.toSorted((a, b) => {
32+
return (
33+
new Date(b.created_at).getTime() - new Date(a.created_at).getTime()
34+
);
35+
}),
36+
});
37+
38+
if (!versions) {
39+
return <Skeleton className="w-28 h-8 rounded-full" />;
40+
}
41+
42+
return (
43+
<Select name="versionId" {...props}>
44+
<PromptSelectTrigger id="versionId" tooltip="Template version">
45+
<SelectValue placeholder="Select a version" />
46+
</PromptSelectTrigger>
47+
<SelectContent>
48+
{versions.map((version) => {
49+
return (
50+
<SelectItem value={version.id} key={version.id}>
51+
<span className="flex items-center gap-2">
52+
{version.name}
53+
{activeVersionId === version.id && (
54+
<Badge size="xs" variant="green">
55+
Active
56+
</Badge>
57+
)}
58+
</span>
59+
</SelectItem>
60+
);
61+
})}
62+
</SelectContent>
63+
</Select>
64+
);
65+
};

0 commit comments

Comments
 (0)