Skip to content

feat: show descriptions for parameter options #10068

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 9 commits into from
Oct 5, 2023
Merged

feat: show descriptions for parameter options #10068

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2b8cd51
feat: show descriptions for parameter options
aslilac Oct 4, 2023
091a97d
go back to a tooltip
aslilac Oct 5, 2023
e14b38c
one lil css tweak
aslilac Oct 5, 2023
7c7b88b
Merge branch 'main' into parameter-descriptions
aslilac Oct 5, 2023
1f64fd5
fix merge
aslilac Oct 5, 2023
d85f4fb
Merge branch 'main' into parameter-descriptions
aslilac Oct 5, 2023
0b36a8d
Merge branch 'main' into parameter-descriptions
aslilac Oct 5, 2023
812b29a
🧹
aslilac Oct 5, 2023
74abeb8
revert `make gen`
aslilac Oct 5, 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
47 changes: 43 additions & 4 deletions site/src/components/RichParameterInput/RichParameterInput.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,39 @@ export const BooleanType: Story = {
},
};

export const OptionsType: Story = {
export const Options: Story = {
args: {
value: "first_option",
id: "options_parameter",
parameter: createTemplateVersionParameter({
name: "options_parameter",
type: "string",
description: "Parameter with options",
options: [
{
name: "First option",
value: "first_option",
description: "",
icon: "/icon/fedora.svg",
},
{
name: "Second option",
value: "second_option",
description: "",
icon: "/icon/database.svg",
},
{
name: "Third option",
value: "third_option",
description: "",
icon: "/icon/aws.png",
},
],
}),
},
};

export const OptionsWithDescriptions: Story = {
args: {
value: "first_option",
id: "options_parameter",
Expand All @@ -82,7 +114,7 @@ export const OptionsType: Story = {
name: "First option",
value: "first_option",
description: "This is option 1",
icon: "",
icon: "/icon/fedora.svg",
},
{
name: "Second option",
Expand Down Expand Up @@ -217,9 +249,16 @@ export const SmallBooleanType: Story = {
},
};

export const SmallOptionsType: Story = {
export const SmallOptions: Story = {
args: {
...Options.args,
size: "small",
},
};

export const SmallOptionsWithDescriptions: Story = {
args: {
...OptionsType.args,
...OptionsWithDescriptions.args,
size: "small",
},
};
Expand Down
34 changes: 25 additions & 9 deletions site/src/components/RichParameterInput/RichParameterInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import { MemoizedMarkdown } from "components/Markdown/Markdown";
import { MultiTextField } from "./MultiTextField";
import Box from "@mui/material/Box";
import { Theme } from "@mui/material/styles";
import { InfoTooltip } from "components/InfoTooltip/InfoTooltip";
import { useTheme } from "@emotion/react";

const isBoolean = (parameter: TemplateVersionParameter) => {
return parameter.type === "bool";
Expand Down Expand Up @@ -95,6 +97,11 @@ const RichParameterField: React.FC<RichParameterInputProps> = ({
...props
}) => {
const styles = useStyles();
const theme = useTheme();

const small = size === "small";

console.log(size);

if (isBoolean(parameter)) {
return (
Expand Down Expand Up @@ -137,19 +144,33 @@ const RichParameterField: React.FC<RichParameterInputProps> = ({
value={option.value}
control={<Radio size="small" />}
label={
<span className={styles.radioOption}>
<Stack direction="row" alignItems="center">
{option.icon && (
<img
className={styles.optionIcon}
alt="Parameter icon"
src={option.icon}
style={{
css={{
pointerEvents: "none",
}}
/>
)}
{option.name}
</span>
{option.description ? (
<Stack
spacing={small ? 1 : 0}
alignItems={small ? "center" : undefined}
css={{ padding: `${theme.spacing(0.5)} 0` }}
direction={small ? "row" : "column"}
>
<span>{option.name}</span>
<MemoizedMarkdown className={styles.labelCaption}>
{option.description}
</MemoizedMarkdown>
</Stack>
) : (
option.name
)}
</Stack>
}
/>
))}
Expand Down Expand Up @@ -281,11 +302,6 @@ const useStyles = makeStyles<Theme>((theme) => ({
height: "100%",
objectFit: "contain",
},
radioOption: {
display: "flex",
alignItems: "center",
gap: theme.spacing(1.5),
},
optionIcon: {
maxHeight: 20,
width: 20,
Expand Down