mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: render Markdown in rich parameter descriptions (#6098)
This commit is contained in:
@@ -753,6 +753,7 @@ export interface TemplateVersion {
|
||||
export interface TemplateVersionParameter {
|
||||
readonly name: string
|
||||
readonly description: string
|
||||
readonly description_plaintext: string
|
||||
readonly type: string
|
||||
readonly mutable: boolean
|
||||
readonly default_value: string
|
||||
|
||||
@@ -7,6 +7,7 @@ import { Stack } from "components/Stack/Stack"
|
||||
import { FC, useState } from "react"
|
||||
import { TemplateVersionParameter } from "../../api/typesGenerated"
|
||||
import { colors } from "theme/colors"
|
||||
import { MemoizedMarkdown } from "components/Markdown/Markdown"
|
||||
|
||||
const isBoolean = (parameter: TemplateVersionParameter) => {
|
||||
return parameter.type === "bool"
|
||||
@@ -41,7 +42,11 @@ const ParameterLabel: FC<ParameterLabelProps> = ({ index, parameter }) => {
|
||||
</label>
|
||||
</span>
|
||||
</span>
|
||||
<span className={styles.labelDescription}>{parameter.description}</span>
|
||||
{parameter.description && (
|
||||
<span className={styles.labelDescription}>
|
||||
<MemoizedMarkdown>{parameter.description}</MemoizedMarkdown>
|
||||
</span>
|
||||
)}
|
||||
{!parameter.mutable && (
|
||||
<div className={styles.labelImmutable}>
|
||||
This parameter cannot be changed after creating workspace.
|
||||
|
||||
@@ -668,6 +668,7 @@ export const MockTemplateVersionParameter1: TypesGen.TemplateVersionParameter =
|
||||
name: "first_parameter",
|
||||
type: "string",
|
||||
description: "This is first parameter",
|
||||
description_plaintext: "Markdown: This is first parameter",
|
||||
default_value: "abc",
|
||||
mutable: true,
|
||||
icon: "/icon/folder.svg",
|
||||
@@ -679,6 +680,7 @@ export const MockTemplateVersionParameter2: TypesGen.TemplateVersionParameter =
|
||||
name: "second_parameter",
|
||||
type: "number",
|
||||
description: "This is second parameter",
|
||||
description_plaintext: "Markdown: This is second parameter",
|
||||
default_value: "2",
|
||||
mutable: true,
|
||||
icon: "/icon/folder.svg",
|
||||
@@ -693,6 +695,7 @@ export const MockTemplateVersionParameter3: TypesGen.TemplateVersionParameter =
|
||||
name: "third_parameter",
|
||||
type: "string",
|
||||
description: "This is third parameter",
|
||||
description_plaintext: "Markdown: This is third parameter",
|
||||
default_value: "aaa",
|
||||
mutable: true,
|
||||
icon: "/icon/database.svg",
|
||||
@@ -706,6 +709,7 @@ export const MockTemplateVersionParameter4: TypesGen.TemplateVersionParameter =
|
||||
name: "fourth_parameter",
|
||||
type: "string",
|
||||
description: "This is fourth parameter",
|
||||
description_plaintext: "Markdown: This is fourth parameter",
|
||||
default_value: "def",
|
||||
mutable: false,
|
||||
icon: "/icon/database.svg",
|
||||
@@ -717,6 +721,7 @@ export const MockTemplateVersionParameter5: TypesGen.TemplateVersionParameter =
|
||||
name: "fifth_parameter",
|
||||
type: "number",
|
||||
description: "This is fifth parameter",
|
||||
description_plaintext: "Markdown: This is fifth parameter",
|
||||
default_value: "5",
|
||||
mutable: true,
|
||||
icon: "/icon/folder.svg",
|
||||
|
||||
Reference in New Issue
Block a user