inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2135] Updated tables of contents (#2822)

Browse Source
This commit is contained in:
Andy Stark
2018-01-12 13:26:11 +00:00
committed by Eugenio Romano
parent 72cfd7894d
commit 69e40ea1c0
17 changed files with 164 additions and 353 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/login.component.md
+22 -25
View File
@@ -4,25 +4,22 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
![Login component](docassets/images/custom-footer.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
## Contents
<!-- toc -->
- [Basic usage](#basic-usage)
- [Basic usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
- [Details](#details)
* [Handling events](#handling-events)
* [Change footer content](#change-footer-content)
* [Change header content](#change-header-content)
* [Extra content](#extra-content)
* [Custom logo and background](#custom-logo-and-background)
* [Customize Validation rules](#customize-validation-rules)
* [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
- [Properties](#properties)
- [Events](#events)
<!-- tocstop -->
- [Details](#details)
<!-- markdown-toc end -->
- [Handling events](#handling-events)
- [Change footer content](#change-footer-content)
- [Change header content](#change-header-content)
- [Extra content](#extra-content)
- [Custom logo and background](#custom-logo-and-background)
- [Customize Validation rules](#customize-validation-rules)
- [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
## Basic usage
@@ -36,23 +33,23 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
### Properties
| Name | Type | Default Value | Description |
| --- | --- | --- | --- |
| providers | string | | Possible valid values are ECM, BPM or ALL. The default behaviour of this component will log in only in the ECM . If you want to log in in both systems the correct value to use is ALL. |
| successRoute | string | | Route to redirect to upon successful login. |
| ---- | ---- | ------------- | ----------- |
| providers | string | | Possible valid values are ECM, BPM or ALL. The default behaviour of this component will log in only in the ECM . If you want to log in in both systems the correct value to use is ALL. |
| successRoute | string | | Route to redirect to upon successful login. |
| disableCsrf | boolean | false | To prevent the CSRF Token from being submitted. Only for Alfresco Process Services call |
| needHelpLink | string | | It will change the url of the NEED HELP link in the footer |
| registerLink | string | | It will change the url of the REGISTER link in the footer |
| logoImageUrl | string | \<ADF logo image> | To change the logo image with a customised image |
| copyrightText | string | \<ADF copyright string> | The copyright text below the login box |
| backgroundImageUrl | string | \<ADF background image> | To change the background image with a customised image |
| fieldsValidation | { [key: string]: any; }, extra?: { [key: string]: any; } | | Use it to customise the validation rules of the login form |
| needHelpLink | string | | It will change the url of the NEED HELP link in the footer |
| registerLink | string | | It will change the url of the REGISTER link in the footer |
| logoImageUrl | string | \\<ADF logo image> | To change the logo image with a customised image |
| copyrightText | string | \\<ADF copyright string> | The copyright text below the login box |
| backgroundImageUrl | string | \\<ADF background image> | To change the background image with a customised image |
| fieldsValidation | { [key: string]&#x3A; any; }, extra?: { [key: string]&#x3A; any; } | | Use it to customise the validation rules of the login form |
| showRememberMe | boolean | false | Toggle `Remember me` checkbox visibility |
| showLoginActions | boolean | false | Toggle extra actions visibility (`Need Help`, `Register`, etc.) |
### Events
| Name | Description |
| --- | --- |
| ---- | ----------- |
| success | Raised when the login is done |
| error | Raised when the login fails |
| executeSubmit | Raised when the form is submitted |