Merge pull request #28009 from gavinclarkeuk/template-input-docs

docs(scaffolder): Add more template input examples
2024-12-06 11:21:52 -08:00
parent 8ca1549547 93bfd674db
commit 890e983440
1 changed files with 65 additions and 0 deletions
@@ -198,6 +198,23 @@ parameters:
        ui:widget: checkboxes
 ```

+## Markdown text blocks
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      markdown:
+        type: 'null' # Needs to be quoted
+        description: |
+          ## Markdown Text Block
+
+          Standard markdown formatting is supported including *italics*, **bold** and [links](https://example.com)
+
+          * bullet 1
+          * bullet 2
+```
+
 ## Use parameters as condition in steps

 Conditions use Javascript equality operators.
@@ -250,6 +267,54 @@ parameters:
                - lastName
 ```

+### Multiple conditional fields with custom ordering
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    ui:order:
+      - includeName
+      - lastName
+      - includeAddress
+      - address
+    properties:
+      includeName:
+        title: Include Name?
+        type: boolean
+        default: true
+      includeAddress:
+        title: Include Address?
+        type: boolean
+        default: true
+    dependencies:
+      includeName:
+        allOf:
+          - if:
+              properties:
+                includeName:
+                  const: true
+            then:
+              properties:
+                lastName:
+                  title: Name
+                  type: string
+              required:
+                - lastName
+      includeAddress:
+        allOf:
+          - if:
+              properties:
+                includeAddress:
+                  const: true
+            then:
+              properties:
+                address:
+                  title: Address
+                  type: string
+              required:
+                - address
+```
+
 ## Conditionally set parameters

 The `if` keyword within the parameter uses [nunjucks templating](https://mozilla.github.io/nunjucks/templating.html#if). The `not` keyword is unavailable; instead, use javascript equality.