Skip to content

Commit

Permalink
Adding more info about helptext
Browse files Browse the repository at this point in the history
  • Loading branch information
OsamaAbdellateef committed Oct 9, 2024
1 parent 4fa8999 commit 412bb1b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/content/getting-started/form-fields.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Labels are essential for accessibility and clarity, ensuring that each form fiel

However, labels might not be necessary when the purpose of the input is obvious from context. For example, in search bars because the purpose of the input is obvious

Helper Text, on the other hand, should complement the label by providing additional context or validation message.
Help Text should be used to provide additional clarification or instructions when the label alone isn't enough to explain the input (e.g., complex or uncommon fields). It’s helpful for explaining specific formats or validation rules. However, it shouldn't be used when the input is straightforward and the label is clear, as it can clutter the form and overwhelm the user with unnecessary details.

<ComponentDemo file="./form-guideline-helper-text.demo.tsx" />

Expand Down

0 comments on commit 412bb1b

Please sign in to comment.