Merge pull request #6423 from chicoribas/Mask-or-hide-values-on-Scaffolder-Review-Step

Mask or hide values on scaffolder review step
2021-07-14 18:25:03 +02:00
parent 7703516ad8 c87f271a52
commit 12a62ea5f6
4 changed files with 180 additions and 3 deletions
@@ -227,6 +227,33 @@ spec:
            inputType: tel
 ```

+#### Hide or mask sensitive data on Review step
+
+Sometimes, specially in custom fields, you collect some data on Create form that
+must not be shown to the user on Review step. To hide or mask this data, you can
+use `ui:widget: password` or set some properties of `ui:backstage`:
+
+```yaml
+- title: Hide or mask values
+  properties:
+    password:
+      title: Password
+      type: string
+      ui:widget: password # will print '******' as value for property 'password' on Review Step
+    masked:
+      title: Masked
+      type: string
+      ui:backstage:
+        review:
+          mask: '<some-value-to-show>' # will print '<some-value-to-show>' as value for property 'Masked' on Review Step
+    hidden:
+      title: Hidden
+      type: string
+      ui:backstage:
+        review:
+          show: false # wont print any info about 'hidden' property on Review Step
+```
+
 #### The Repository Picker

 So in order to make working with repository providers easier, we've built a