Skip to content

Commit 6e17754

Browse files
committed
Add example screenshot of dropdown item type
1 parent e22ae70 commit 6e17754

File tree

3 files changed

+27
-9
lines changed

3 files changed

+27
-9
lines changed

docs/reference/custom-resource-config.mdx

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,9 @@ The `bool` input type should use a "0" or "1" to set the value
510510
default: "0"
511511
```
512512

513-
![Boolean selector on the configuration screen](../../static/images/config-screen-bool.png)
513+
![Boolean selector on the configuration screen](/images/config-screen-bool.png)
514+
515+
[View a larger version of this image](/images/config-screen-bool.png)
514516

515517
### `dropdown`
516518

@@ -541,6 +543,14 @@ spec:
541543
title: 1.2.5
542544
```
543545

546+
![Dropdown item type on config screen](/images/config-screen-dropdown.png)
547+
548+
[View a larger version of this image](/images/config-screen-dropdown.png)
549+
550+
![Dropdown item type expanded](/images/config-screen-dropdown-open.png)
551+
552+
[View a larger version of this image](/images/config-screen-dropdown-open.png)
553+
544554
### `file`
545555
A `file` is a special type of form field that renders an [`<input type="file" />`](https://www.w3schools.com/tags/tag_input.asp) HTML element.
546556
Only the contents of the file, not the name, are captured.
@@ -558,7 +568,9 @@ See the [`ConfigOptionData`](template-functions-config-context#configoptiondata)
558568
type: file
559569
```
560570

561-
![File input field on the configuration screen](../../static/images/config-screen-file.png)
571+
![File input field on the configuration screen](/images/config-screen-file.png)
572+
573+
[View a larger version of this image](/images/config-screen-file.png)
562574

563575
### `heading`
564576
The `heading` type allows you to display a group heading as a sub-element within a group.
@@ -575,7 +587,9 @@ This is useful when you would like to use a config group to group items together
575587
...
576588
```
577589

578-
![Heading on the configuration screen](../../static/images/config-screen-heading.png)
590+
![Heading on the configuration screen](/images/config-screen-heading.png)
591+
592+
[View a larger versio of this image](/images/config-screen-heading.png)
579593

580594
### `label`
581595
The `label` type allows you to display an input label.
@@ -590,7 +604,9 @@ The `label` type allows you to display an input label.
590604
type: label
591605
title: "Note: The system will send you an email every hour."
592606
```
593-
![Email address label on the configuration screen](../../static/images/config-screen-label.png)
607+
![Email address label on the configuration screen](/images/config-screen-label.png)
608+
609+
[View a larger version of this image](/images/config-screen-label.png)
594610

595611
### `password`
596612
The `password` type is a text field that hides the character input.
@@ -602,7 +618,9 @@ The `password` type is a text field that hides the character input.
602618
value: '{{repl RandomString 10}}'
603619
```
604620

605-
![Password text field on the configuration screen](../../static/images/config-screen-password.png)
621+
![Password text field on the configuration screen](/images/config-screen-password.png)
622+
623+
[View a larger version of this image](/images/config-screen-password.png)
606624

607625
### `radio`
608626

@@ -671,7 +689,7 @@ Optionally, all additional properties are available for this input type.
671689
type: text
672690
```
673691

674-
![Text field on the configuration screen](../../static/images/config-screen-text.png)
692+
![Text field on the configuration screen](/images/config-screen-text.png)
675693

676694
:::important
677695
Do not store secrets or passwords in `text` items because they are not encrypted or masked and can be easily accessed. Instead, use [`password`](#password) items.
@@ -692,7 +710,7 @@ A `textarea` items creates a multi-line text input for when users have to enter
692710
title: Hostname
693711
type: text
694712
```
695-
![Text area field on the configuration screen](../../static/images/config-screen-textarea.png)
713+
![Text area field on the configuration screen](/images/config-screen-textarea.png)
696714

697715
## Item Validation
698716

@@ -714,9 +732,9 @@ For applications installed with KOTS v1.98.0 or later, a `regex` can be used to
714732

715733
<RegexValidationExample/>
716734

717-
![Password validation error](../../static/images/regex_password_validation_error.png)
735+
![Password validation error](/images/regex_password_validation_error.png)
718736

719-
![File validation error only when uploaded](../../static/images/regex_file_validation_error.png)
737+
![File validation error only when uploaded](/images/regex_file_validation_error.png)
720738

721739
## Repeatable Items
722740

84.6 KB
Loading
29.6 KB
Loading

0 commit comments

Comments
 (0)