-
Notifications
You must be signed in to change notification settings - Fork 1
Design Guidelines Param
Marc-Elian Begin edited this page Oct 12, 2018
·
1 revision
This page provides guidelines for showing parameters in a page.
The basic way of showing a parameter is to provide the following information:
- Name: camel case separated (e.g. aSimpleParamName -> A simple param name)
- Value: see below the different possible rendering
- Description as a tooltip
The value of different parameter types should be rendered differently:
- Password: show only stars (e.g. ***), provide copy icon, right of the value, to copy value to the clipboard
- Text: limit size to width of the column (and show full text in tooltip if hover over?)
- Long text: textarea with wrap around that the user can resize
- URL: display as link
Note: sensitive data such as certificates (e.g. NuvlaBox) should be treated as passwords (see above).