Skip to content

feat(site): Support list(string) rich parameter field #6653

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 3 commits into from
Mar 17, 2023
Merged

feat(site): Support list(string) rich parameter field #6653

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb1ca9e
Add MultiTextField
BrunoQuaresma Mar 17, 2023
55e272a
Add field to reach parameters input
BrunoQuaresma Mar 17, 2023
1b0d866
Minor fixes
BrunoQuaresma Mar 17, 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
Prev Previous commit
Next Next commit
Add field to reach parameters input
  • Loading branch information
@BrunoQuaresma
BrunoQuaresma committed Mar 17, 2023
commit 55e272a95a416fdaad02f70b22e4ddd0e79827cc
1 change: 1 addition & 0 deletions site/src/components/MultiTextField/MultiTextField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ const useStyles = makeStyles((theme) => ({
flexWrap: "wrap",
gap: theme.spacing(1),
position: "relative",
margin: theme.spacing(1, 0, 0.5), // Have same margin than TextField

"&:has(input:focus)": {
borderColor: theme.palette.primary.main,
Expand Down
12 changes: 12 additions & 0 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 @@ -31,6 +31,7 @@ const createTemplateVersionParameter = (
validation_max: 0,
validation_monotonic: "increasing",
description_plaintext: "",
required: true,
...partial,
}
}
Expand Down Expand Up @@ -99,6 +100,17 @@ OptionsType.args = {
}),
}

export const ListStringType = Template.bind({})
ListStringType.args = {
initialValue: JSON.stringify(["first", "second", "third"]),
id: "list_string_parameter",
parameter: createTemplateVersionParameter({
name: "list_string_parameter",
type: "list(string)",
description: "List string parameter",
}),
}

export const IconLabel = Template.bind({})
IconLabel.args = {
initialValue: "initial-value",
Expand Down
27 changes: 27 additions & 0 deletions site/src/components/RichParameterInput/RichParameterInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { FC, useState } from "react"
import { TemplateVersionParameter } from "../../api/typesGenerated"
import { colors } from "theme/colors"
import { MemoizedMarkdown } from "components/Markdown/Markdown"
import { MultiTextField } from "components/MultiTextField/MultiTextField"

const isBoolean = (parameter: TemplateVersionParameter) => {
return parameter.type === "bool"
Expand Down Expand Up @@ -154,6 +155,32 @@ const RichParameterField: React.FC<RichParameterInputProps> = ({
)
}

if (parameter.type === "list(string)") {
let values: string[] = []

if (parameterValue) {
try {
values = JSON.parse(parameterValue) as string[]
} catch (e) {
console.error("Error parsing list(string) parameter", e)
}
}

return (
<MultiTextField
label={props.label as string}
values={values}
onChange={(values) => {
try {
onChange(JSON.stringify(values))
} catch (e) {
console.error("Error on change of list(string) parameter", e)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to do anything else with error handling here or on line 165?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is something we control but in case it gets an error, I added a message to help a bit more.

}
}}
/>
)
}

// A text field can technically handle all cases!
// As other cases become more prominent (like filtering for numbers),
// we should break this out into more finely scoped input fields.
Expand Down