Skip to content

Design Guidelines Param

Marc-Elian Begin edited this page Oct 12, 2018 · 1 revision

Parameters

This page provides guidelines for showing parameters in a page.

The basic way of showing a parameter is to provide the following information:

  1. Name: camel case separated (e.g. aSimpleParamName -> A simple param name)
  2. Value: see below the different possible rendering
  3. Description as a tooltip

The value of different parameter types should be rendered differently:

  1. Password: show only stars (e.g. ***), provide copy icon, right of the value, to copy value to the clipboard
  2. Text: limit size to width of the column (and show full text in tooltip if hover over?)
  3. Long text: textarea with wrap around that the user can resize
  4. URL: display as link

Note: sensitive data such as certificates (e.g. NuvlaBox) should be treated as passwords (see above).

Clone this wiki locally