@igamingcareer/igaming-components 1.0.102 → 1.0.103

package/Readme.md

@@ -69,6 +69,36 @@ export function Example() {
 }
 ```
 
+## Login (remember me identifier)
+
+The `Login` and `LoginForm` components support a real “Remember me” experience by persisting the identifier (email/username)
+separately from the checkbox state. When the user opts in, the identifier is stored in `localStorage`, and on the next visit the
+identifier field is prefilled and focus moves to the password input. Passwords are never persisted.
+
+```tsx
+import { Login } from "@igamingcareer/igaming-components";
+import "@igamingcareer/igaming-components/styles/globals.css";
+
+export function LoginScreen() {
+  return (
+    <Login
+      onSubmit={(identifier, password, rememberMe) => {
+        // send credentials to your API
+      }}
+      rememberIdentifierPersistKey="igaming-auth-identifier"
+      defaultPrefilledIdentifier="player@example.com"
+    />
+  );
+}
+```
+
+**Behavior details**
+
+- The checkbox state is persisted via `rememberMeStorageKey` (default: `"igaming-auth-remember-me"`).
+- When `rememberMe` is true on submit, the identifier is stored at `rememberIdentifierPersistKey`. If `rememberMe` is false, the
+  identifier is removed.
+- On mount, if `rememberMe` is true and a stored identifier exists, the identifier is prefilled and the password input is focused.
+
 ## Notifications (global notification system)
 
 The notification system provides a provider, hook, and global helpers to trigger messages from anywhere in your app.