Helper text

Documentation Index

Fetch the complete documentation index at: https://docs.cognite.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Helper text

​

When to use

• Format requirements the user needs before they start typing (“Must be at least 8 characters”).
• Validation feedback after a field has been interacted with.
• Contextual hints that reduce input errors.

​

When not to use

• Long explanations — use a Popover or Popover instead.
• Page-level or section-level guidance — use Alert or plain text.

​

Dos and don’ts

• Do show format hints upfront, not only after the user has already made a mistake.
• Do replace the default helper text with the error message when validation fails — don’t stack both.
• Do keep it to one or two short sentences — if you need more than that, the field or the form design probably needs rethinking.
• Do ensure error messages say what’s wrong and how to fix it, not just that something is wrong (“Enter a valid email address” not “Invalid input”).
• Don’t use it for information the user doesn’t need to complete the field.
• Don’t write helper text that just restates the label in different words.

​

Often used with

• Tied to a single field: always with that control’s Label and one of Input, Textarea, Select, Combobox, Checkbox / Radio group, or Switch.