Skip to content

Commit 0b12903

Browse files
authored
feat(docs): add first version of sign-in ux docs page (#1528)
* feat(docs): add first version of sign-in ux docs page * Add initial sign-in UX documentation page * fix(docs): fix formatting
1 parent 9afeac6 commit 0b12903

3 files changed

Lines changed: 26 additions & 1 deletion

File tree

.changeset/stale-onions-know.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
3+
---
4+
5+
feat(docs): add first version of sign-in ux docs page

docs/ux/0_contents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
4. [UX Patterns](ux-patterns-md)
2626
1. Page And User Flow
2727
2. Authentication And Access
28-
1. Sign In
28+
1. [Sign In](sign-in.md)
2929
2. [UI For Unauthorized Users](ui-for-unauthorized-users.md)
3030
3. Displaying and Interacting With Data
3131
4. Wizard Pattern

docs/ux/sign-in.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[← Back to Contents Overview](0_contents.md)
2+
3+
# Sign-In
4+
5+
> [!NOTE]
6+
> The below mentioned sign-in form templates have not yet been implemented and are not yet available.
7+
8+
There is a dedicated `SignInForm`component to be used when implementing sign-in forms and pages.
9+
10+
Always use a dedicated sign-in page, do not use modals to display sign-in forms.
11+
12+
There are several designs for sign-in pages which can be found as re-usable templates in storybook.
13+
14+
## Sign-In Form Validation
15+
16+
## Failed Sign-In
17+
18+
When signing-in a user failed, the respective messaging should **never** give away any exact information about the failed sign-in that would give an attacker information they did not have before. For example, the messaging must not state whether an account exists with the user name or email that was attempted to sign in with.
19+
20+
The same goes for when a user tried to reset a password: The message should never state whether an account for the email or user name the password was attempted to reset for actually exists or not.

0 commit comments

Comments
 (0)