Login - AFS

AFS Integration Guide

Product
AFS
AFS_Version
7.7
Category
Reference Guide

The Login widget is the entry point of a new category of widgets and functionalities. Those new capabilities require ACS to be installed.

When a user logs in through this Login widget, all widgets that require authentication wake up and display themselves in the page.

Those widgets bring capabilities of saving and listing scheduled searches and bookmarks for example.

At login time, if a user checks the "Remember me" box, its authentication information is stored on the client side in a cookie.

If the user unchecks the same box, all stored information is removed.

The Logout widget enables users to log out. This causes all CKS widgets to sleep.

The login widget can be used with default parameters:

<div class="AFSWidget" title="Login"></div>

Or can be customize, using parameters described below:

<div class="AFSWidget" title="Login">
<script type="application/json">
{
"usernameFieldLabel": "Username",
"passwordFieldLabel": "Password",
"rememberMeCheckboxLabel": "Remember me",
"cancelButtonLabel": "Cancel",
"submitButtonLabel": "Login",
"loginLabel": "Login",
}
</script>
</div>

Login - The ACS authentication widget

Parameter

Type

Card

Default

Description

usernameFieldLabel

String

Optional

Username

The label associated to the username field.

passwordFieldLabel

String

Optional

Password

The label associated to the password field.

rememberMeCheckboxLabel

String

Optional

Remember me

The label associated to the remember-me checkbox.

cancelButtonLabel

String

Optional

Cancel

The label of the button used to close the popup form.

submitButtonLabel

String

Optional

Login

The label of the button used to submit the form.

loginLabel

String

optional

Login

Label of the login button

usernameFieldPlaceholder

String

Optional

The label to use as placeholder in the username field

passwordFieldPlaceholder

String

Optional

The label to use as placeholder in the password field

loginPanelTitle

String

Optional

User Connection

The text of the login panel title

outsideClickTogglePanel

Boolean

optional

false

Indicates if the click has to be monitored to change the widget state. See tip below.

forgotPasswordButtonLabel

String

Optional

"Forgot Password"

Label of the button to use to display the password recovery form;

passwordRecoveryButtonLabel

String

Optional

"Recover Password"

Label of the submit button in the recovery form;

At integration time, the widget can be styled as a pop-up. The click on the main button toggles the presence of a CSS class on the widget top-level container, allowing to update the panel visibility. If styled as a pop-up, the outsideClickTogglePanel option can be useful to change the widget state when a click occurs outside of the widget panel, by removing the previously mentioned CSS class.