mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3551] Doc fixes for release (#3849)
* [ADF-3551] Fixed missing docs index pages and links * [ADF-3551] Fixed link in datatable docs plus ToC tool update
This commit is contained in:
committed by
Eugenio Romano
parent
e28850055c
commit
0ed5b2d5de
@@ -32,6 +32,8 @@ for more information about installing and using the source code.
|
||||
| [Header component](header.component.md)  | Reusable header for Alfresco applications. | [Source](../../lib/core/layout/components/header/header.component.ts) |
|
||||
| [Sidebar action menu component](sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) |
|
||||
| [Sidenav layout component](sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) |
|
||||
| [Login dialog panel component](login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../../lib/core/login/components/login-dialog-panel.component.ts) |
|
||||
| [Login dialog component](login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../../lib/core/login/components/login-dialog.component.ts) |
|
||||
| [Login component](login.component.md) | Authenticates to Alfresco Content Services and or Alfresco Process Services. | [Source](../../lib/core/login/components/login.component.ts) |
|
||||
| [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../../lib/core/pagination/infinite-pagination.component.ts) |
|
||||
| [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../../lib/core/pagination/pagination.component.ts) |
|
||||
@@ -106,6 +108,7 @@ for more information about installing and using the source code.
|
||||
| [Favorites api service](favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../../lib/core/services/favorites-api.service.ts) |
|
||||
| [Highlight transform service](highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../../lib/core/services/highlight-transform.service.ts) |
|
||||
| [Log service](log.service.md) | Provides log functionality. | [Source](../../lib/core/services/log.service.ts) |
|
||||
| [Login dialog service](login-dialog.service.md) | Manages login dialogs. | [Source](../../lib/core/services/login-dialog.service.ts) |
|
||||
| [Nodes api service](nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../../lib/core/services/nodes-api.service.ts) |
|
||||
| [Notification service](notification.service.md) | Shows a notification message with optional feedback. | [Source](../../lib/core/services/notification.service.ts) |
|
||||
| [Page title service](page-title.service.md) | Sets the page title. | [Source](../../lib/core/services/page-title.service.ts) |
|
||||
|
@@ -250,7 +250,7 @@ You can add [Data column component](data-column.component.md) instances to defin
|
||||
table as described in the usage examples and the [Customizing columns](#customizing-columns) section.
|
||||
|
||||
You can also supply a `<no-content-template>` or an
|
||||
[Empty list component](empty-list-component.md) sub-component to show when the table is empty:
|
||||
[Empty list component](empty-list.component.md) sub-component to show when the table is empty:
|
||||
|
||||
```html
|
||||
<adf-datatable ...>
|
||||
|
@@ -1,5 +1,5 @@
|
||||
---
|
||||
Added: v2.4.0
|
||||
Added: v2.5.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2018-08-07
|
||||
---
|
||||
|
26
docs/core/login-dialog-panel.component.md
Normal file
26
docs/core/login-dialog-panel.component.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
Added: v2.6.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-10-02
|
||||
---
|
||||
|
||||
# Login Dialog Panel component
|
||||
|
||||
Shows and manages a login dialog.
|
||||
|
||||
## Class members
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds |
|
||||
|
||||
## Details
|
||||
|
||||
This component has similar features to the [Login Dialog component](../core/login-dialog.component.md)
|
||||
but it also creates and manages the dialog for you.
|
||||
|
||||
## See also
|
||||
|
||||
- [Login Dialog component](../core/login-dialog.component.md)
|
@@ -1,20 +1,20 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Added: v2.6.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-04-18
|
||||
Last reviewed: 2018-10-02
|
||||
---
|
||||
|
||||
# Content Node Selector component
|
||||
# Login Dialog component
|
||||
|
||||
Allows a user to perform a login via a dialog.
|
||||
|
||||
## Details
|
||||
|
||||
The [Login Dialog component](../core/login-dialog.component.md) allow you to perform a login via a dialog.
|
||||
The [Login Dialog component](../core/login-dialog.component.md) allows you to perform a login via a dialog.
|
||||
|
||||
### Showing the dialog
|
||||
|
||||
Unlike most components, the Login Dialog Component is typically shown in a dialog box
|
||||
Unlike most components, the [Login Dialog Component](../core/login-dialog.component.md) is typically shown in a dialog box
|
||||
rather than the main page and you are responsible for opening the dialog yourself. You can use the
|
||||
[Angular Material Dialog](https://material.angular.io/components/dialog/overview) for this,
|
||||
as shown in the usage example. ADF provides the [`LoginDialogComponentData`](../../lib/core/login/components/login-dialog-component-data.interface.ts) interface
|
||||
@@ -35,7 +35,7 @@ The properties are described in the table below:
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| title | `string` | "" | Dialog title |
|
||||
| actionName | `string` | "" | Text to appear on the dialog's main action button ("Login", "Access", etc) |
|
||||
| logged | [`EventEmitter<any>`]| | Event emitted when the login succeeds. |
|
||||
| logged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | | Event emitted when the login succeeds. |
|
||||
|
||||
If you don't want to manage the dialog yourself then it is easier to use the
|
||||
[Login Dialog Panel component](login-dialog-panel.component.md), or the
|
||||
@@ -52,7 +52,7 @@ import { Subject } from 'rxjs/Subject';
|
||||
|
||||
constructor(dialog: MatDialog ... ) {}
|
||||
|
||||
openSelectorDialog() {
|
||||
openLoginDialog() {
|
||||
data: LoginDialogComponentData = {
|
||||
title: "Perform a Login",
|
||||
actionName: "Access",
|
||||
@@ -62,7 +62,7 @@ openSelectorDialog() {
|
||||
this.dialog.open(
|
||||
LoginDialogComponent,
|
||||
{
|
||||
data, panelClass: 'adf-content-node-selector-dialog',
|
||||
data, panelClass: 'adf-login-dialog',
|
||||
width: '630px'
|
||||
}
|
||||
);
|
||||
@@ -82,3 +82,7 @@ openSelectorDialog() {
|
||||
|
||||
All the results will be streamed to the logged [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the [`LoginDialogComponentData`](../../lib/core/login/components/login-dialog-component-data.interface.ts) object passed to the dialog.
|
||||
When the dialog action is selected by clicking, the `data.logged` stream will be completed.
|
||||
|
||||
## See also
|
||||
|
||||
- [Login component](login.component.md)
|
||||
|
30
docs/core/login-dialog.service.md
Normal file
30
docs/core/login-dialog.service.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
Added: v2.6.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-10-02
|
||||
---
|
||||
|
||||
# Login Dialog service
|
||||
|
||||
Manages login dialogs.
|
||||
|
||||
## Methods
|
||||
|
||||
- **openLogin**(actionName: `string`, title: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
|
||||
Opens a login dialog.
|
||||
- _actionName:_ `string` - Text to show in the main action button
|
||||
- _title:_ `string` - Title for the login dialog
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - Confirmation of login from the dialog
|
||||
- **close**(): `<void>`<br/>
|
||||
Closes the currently open login dialog.
|
||||
|
||||
## Details
|
||||
|
||||
Use the methods of this service to manage login dialogs from code. As an alternative, you may
|
||||
find it easier to use the [Login dialog component](login-dialog.component.md) to display the
|
||||
dialog directly from HTML.
|
||||
|
||||
## See also
|
||||
|
||||
- [Login dialog component](login-dialog.component.md)
|
||||
- [Login component](login.component.md)
|
Reference in New Issue
Block a user