From 581867ad6621882a3ee2f8a854b4ef8320133ac2 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Thu, 7 Jun 2018 14:21:40 +0100 Subject: [PATCH] [ADF-3142] Added missing info about 'remember me' in login docs (#3448) --- docs/core/login.component.md | 2 +- lib/core/login/components/login.component.ts | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/core/login.component.md b/docs/core/login.component.md index 978a2f81b0..19f637aa70 100644 --- a/docs/core/login.component.md +++ b/docs/core/login.component.md @@ -54,7 +54,7 @@ Authenticates to Alfresco Content Services and Alfresco Process Services. | providers | `string` | | Possible valid values are ECM, BPM or ALL. By default, this component will log in only to ECM. If you want to log in in both systems then use ALL. | | registerLink | `string` | "" | Sets the URL of the REGISTER link in the footer. | | showLoginActions | `boolean` | true | Should the extra actions (`Need Help`, `Register`, etc) be shown? | -| showRememberMe | `boolean` | true | Should the `Remember me` checkbox be shown? | +| showRememberMe | `boolean` | true | Should the `Remember me` checkbox be shown? When selected, this option will remember the logged-in user after the browser is closed to avoid logging in repeatedly. | | successRoute | `string` | null | Route to redirect to on successful login. | ### Events diff --git a/lib/core/login/components/login.component.ts b/lib/core/login/components/login.component.ts index f5f3a41d70..575391aa92 100644 --- a/lib/core/login/components/login.component.ts +++ b/lib/core/login/components/login.component.ts @@ -58,7 +58,11 @@ export class LoginComponent implements OnInit { isPasswordShow: boolean = false; - /** Should the `Remember me` checkbox be shown? */ + /** + * Should the `Remember me` checkbox be shown? When selected, this + * option will remember the logged-in user after the browser is closed + * to avoid logging in repeatedly. + */ @Input() showRememberMe: boolean = true;