Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(password): initial developer guidance #108

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(password): initial developer guidance #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions 2019-password-developer-guidance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
category: component developer guidance
state: draft
created: 2024-11-12
updated: 2024-11-12
---

# Password Developer Guidance

A [password](https://clarity.design/documentation/password) component is an input field that allows users to toggle between hiding or showing the password in plain text.

## Guidance

- A password field **must** be used when the user needs to set or input a password. This ensures security and consistency across the interface.
- An asterisk (\*) **must not** be used in the password field. Instead, use dots or bullets to mask the password for consistency and clarity.
- Password requirements **should** be used in the helper text to guide the user, helping them create valid passwords without confusion.
- Password requirements **should not** hidden in a signpost or revealed to the user only after the user fails the first attempt. Providing them upfront helps prevent frustration and improves the user experience.
- A password field **may** be used when the user needs to mask the input content to protect sensitive information, even if it is not a password.
- Error states on the password input **may** be used to communicate a user or system error. This validation can happen immediately after the input looses focus.
- Success states on the password input **may** be used to communicate success info such as if the user password meets the password requirement criteria.

## Changelog

- **2024-11-12**: Initial guidance
Loading