Skip to content

refactor(site): improve templates empty state #10518

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.

Sign up for GitHub

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

Merged
merged 11 commits into from
Nov 6, 2023
Merged

refactor(site): improve templates empty state #10518

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e3a351e
Redirects to template after setup
BrunoQuaresma Nov 3, 2023
cae37d5
Refactor template example cards and first create template experience
BrunoQuaresma Nov 3, 2023
d8987b9
Minor improvements
BrunoQuaresma Nov 3, 2023
bdb43c6
Fix verbiage
BrunoQuaresma Nov 3, 2023
4109264
Fix test
BrunoQuaresma Nov 3, 2023
935b09b
Fix template display name on card
BrunoQuaresma Nov 3, 2023
250f764
Refactor card layout
BrunoQuaresma Nov 3, 2023
817c01f
Merge branch 'main' of https://github.com/coder/coder into bq/improve…
BrunoQuaresma Nov 6, 2023
6acd193
Move readmore to be inline
BrunoQuaresma Nov 6, 2023
db54495
Merge branch 'main' of https://github.com/coder/coder into bq/improve…
BrunoQuaresma Nov 6, 2023
7453346
Decrease line height
BrunoQuaresma Nov 6, 2023
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
179 changes: 103 additions & 76 deletions site/src/components/TemplateExampleCard/TemplateExampleCard.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,86 +1,113 @@
import { type Interpolation, type Theme } from "@emotion/react";
import Button from "@mui/material/Button";
import Link from "@mui/material/Link";
import type { TemplateExample } from "api/typesGenerated";
import { type FC } from "react";
import { Link } from "react-router-dom";
import { Pill } from "components/Pill/Pill";
import { HTMLProps } from "react";
import { Link as RouterLink } from "react-router-dom";

export interface TemplateExampleCardProps {
type TemplateExampleCardProps = {
example: TemplateExample;
className?: string;
}
activeTag?: string;
} & HTMLProps<HTMLDivElement>;

export const TemplateExampleCard: FC<TemplateExampleCardProps> = ({
example,
className,
}) => {
export const TemplateExampleCard = (props: TemplateExampleCardProps) => {
const { example, activeTag, ...divProps } = props;
return (
<Link
to={`/starter-templates/${example.id}`}
css={styles.template}
className={className}
key={example.id}
<div
css={(theme) => ({
width: "320px",
padding: theme.spacing(3),
borderRadius: 6,
border: `1px solid ${theme.palette.divider}`,
textAlign: "left",
textDecoration: "none",
color: "inherit",
display: "flex",
flexDirection: "column",
})}
{...divProps}
>
<div css={styles.templateIcon}>
<img src={example.icon} alt="" />
<div
css={{
flexShrink: 0,
paddingTop: 4,
width: 32,
height: 32,
marginBottom: 16,
}}
>
<img
src={example.icon}
alt=""
css={{ width: "100%", height: "100%", objectFit: "contain" }}
/>
</div>
<div css={styles.templateInfo}>
<span css={styles.templateName}>{example.name}</span>
<span css={styles.templateDescription}>{example.description}</span>
</div>
</Link>
);
};

const styles = {
template: (theme) => ({
border: `1px solid ${theme.palette.divider}`,
borderRadius: theme.shape.borderRadius,
background: theme.palette.background.paper,
textDecoration: "none",
textAlign: "left",
color: "inherit",
display: "flex",
alignItems: "center",
height: "fit-content",

"&:hover": {
backgroundColor: theme.palette.background.paperLight,
},
}),

templateIcon: (theme) => ({
width: theme.spacing(12),
height: theme.spacing(12),
display: "flex",
alignItems: "center",
justifyContent: "center",
flexShrink: 0,

"& img": {
height: theme.spacing(4),
},
}),
<div>
<h4 css={{ fontSize: 14, fontWeight: 600, margin: 0 }}>
{example.name}
</h4>
<span
css={(theme) => ({
fontSize: 13,
color: theme.palette.text.secondary,
lineHeight: "0.5",
})}
>
{example.description}
</span>
<div css={{ marginTop: 16, display: "flex", flexWrap: "wrap", gap: 8 }}>
{example.tags.map((tag) => {
const isActive = activeTag === tag;

templateInfo: (theme) => ({
padding: theme.spacing(2, 2, 2, 0),
display: "flex",
flexDirection: "column",
overflow: "hidden",
}),

templateName: (theme) => ({
fontSize: theme.spacing(2),
textOverflow: "ellipsis",
width: "100%",
overflow: "hidden",
whiteSpace: "nowrap",
}),
return (
<RouterLink key={tag} to={`/starter-templates?tag=${tag}`}>
<Pill
text={tag}
css={(theme) => ({
borderColor: isActive
? theme.palette.primary.main
: theme.palette.divider,
cursor: "pointer",
backgroundColor: isActive
? theme.palette.primary.dark
: undefined,
"&: hover": {
borderColor: theme.palette.primary.main,
},
})}
/>
</RouterLink>
);
})}
</div>
</div>

templateDescription: (theme) => ({
fontSize: theme.spacing(1.75),
color: theme.palette.text.secondary,
textOverflow: "ellipsis",
width: "100%",
overflow: "hidden",
whiteSpace: "nowrap",
}),
} satisfies Record<string, Interpolation<Theme>>;
<div
css={{
display: "flex",
gap: 12,
flexDirection: "column",
paddingTop: 32,
marginTop: "auto",
alignItems: "center",
}}
>
<Button
component={RouterLink}
fullWidth
to={`/templates/new?exampleId=${example.id}`}
>
Use template
</Button>
<Link
component={RouterLink}
css={{ fontSize: 13 }}
to={`/starter-templates/${example.id}`}
>
Read more
</Link>
</div>
</div>
);
};
2 changes: 1 addition & 1 deletion site/src/pages/SetupPage/SetupPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const SetupPage: FC = () => {
onSubmit={async (firstUser) => {
await createFirstUserMutation.mutateAsync(firstUser);
await signIn(firstUser.email, firstUser.password);
navigate("/");
navigate("/templates");
}}
/>
</>
Expand Down
37 changes: 20 additions & 17 deletions site/src/pages/StarterTemplatesPage/StarterTemplatesPageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,11 @@ export const StarterTemplatesPageView: FC<StarterTemplatesPageViewProps> = ({

{Boolean(!starterTemplatesByTag) && <Loader />}

<Stack direction="row" spacing={4}>
<Stack direction="row" spacing={4} alignItems="flex-start">
{starterTemplatesByTag && tags && (
<Stack css={styles.filter}>
<Stack
css={{ width: 208, flexShrink: 0, position: "sticky", top: 48 }}
>
<span css={styles.filterCaption}>Filter</span>
{tags.map((tag) => (
<Link
Expand All @@ -79,10 +81,24 @@ export const StarterTemplatesPageView: FC<StarterTemplatesPageViewProps> = ({
</Stack>
)}

<div css={styles.templates}>
<div
css={{
display: "flex",
flexWrap: "wrap",
gap: 32,
height: "max-content",
}}
>
{visibleTemplates &&
visibleTemplates.map((example) => (
<TemplateExampleCard example={example} key={example.id} />
<TemplateExampleCard
css={(theme) => ({
backgroundColor: theme.palette.background.paper,
})}
example={example}
key={example.id}
activeTag={activeTag}
/>
))}
</div>
</Stack>
Expand All @@ -91,11 +107,6 @@ export const StarterTemplatesPageView: FC<StarterTemplatesPageViewProps> = ({
};

const styles = {
filter: (theme) => ({
width: theme.spacing(26),
flexShrink: 0,
}),

filterCaption: (theme) => ({
textTransform: "uppercase",
fontWeight: 600,
Expand All @@ -119,12 +130,4 @@ const styles = {
color: theme.palette.text.primary,
fontWeight: 600,
}),

templates: (theme) => ({
flex: "1",
display: "grid",
gridTemplateColumns: "repeat(2, minmax(0, 1fr))",
gap: theme.spacing(2),
gridAutoRows: "min-content",
}),
} satisfies Record<string, Interpolation<Theme>>;
34 changes: 8 additions & 26 deletions site/src/pages/TemplatesPage/EmptyTemplates.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,17 @@ export const EmptyTemplates: FC<{
if (canCreateTemplates) {
return (
<TableEmpty
message="Create a Template"
message="Create your first template"
description={
<>
Templates are written in Terraform and describe the infrastructure
for workspaces (e.g., docker_container, aws_instance,
kubernetes_pod). Select a starter template below or
for workspaces. You can start using a starter template below or{" "}
<Link
href={docs("/templates/tutorial")}
target="_blank"
rel="noreferrer"
>
create your own
creating your own
</Link>
.
</>
Expand All @@ -64,19 +63,15 @@ export const EmptyTemplates: FC<{
<Stack alignItems="center" spacing={4}>
<div css={styles.featuredExamples}>
{featuredExamples.map((example) => (
<TemplateExampleCard
example={example}
key={example.id}
css={styles.template}
/>
<TemplateExampleCard example={example} key={example.id} />
))}
</div>

<Button
size="small"
component={RouterLink}
to="/starter-templates"
css={styles.viewAllButton}
css={{ borderRadius: 9999 }}
>
View all starter templates
</Button>
Expand Down Expand Up @@ -118,22 +113,9 @@ const styles = {
}),

featuredExamples: (theme) => ({
maxWidth: theme.spacing(100),
display: "grid",
gridTemplateColumns: "repeat(2, minmax(0, 1fr))",
display: "flex",
flexWrap: "wrap",
justifyContent: "center",
gap: theme.spacing(2),
gridAutoRows: "min-content",
}),

template: (theme) => ({
backgroundColor: theme.palette.background.paperLight,

"&:hover": {
backgroundColor: theme.palette.divider,
},
}),

viewAllButton: {
borderRadius: 9999,
},
} satisfies Record<string, Interpolation<Theme>>;