inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme update

Browse Source
This commit is contained in:
Denys Vuika
2017-01-03 21:20:16 +00:00
parent 71877aa8d0
commit 7ecf9f2fc3
1 changed files with 14 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
ng2-components/ng2-alfresco-documentlist/README.md
View File

@@ -97,12 +97,10 @@ Follow the 3 steps below:
```html ```html
<alfresco-document-list <alfresco-document-list
#documentList #documentList
[currentFolderPath]="currentPath" [currentFolderId]="'-my-'"
[contextMenuActions]="true" [contextMenuActions]="true"
[contentActions]="true" [contentActions]="true"
[creationMenuActions]="true" [creationMenuActions]="true">
[multiselect]="true"
(folderChange)="onFolderChanged($event)">
</alfresco-document-list> </alfresco-document-list>
``` ```
@@ -120,14 +118,15 @@ import { AlfrescoSettingsService, AlfrescoAuthenticationService } from 'ng2-alfr
@Component({ @Component({
selector: 'alfresco-app-demo', selector: 'alfresco-app-demo',
template: `<alfresco-document-list template: `
<alfresco-document-list
#documentList #documentList
[currentFolderPath]="'/'" [currentFolderPath]="'-my-'"
[contextMenuActions]="true" [contextMenuActions]="true"
[contentActions]="true" [contentActions]="true"
[creationMenuActions]="true" [creationMenuActions]="true">
[multiselect]="true"> </alfresco-document-list>
</alfresco-document-list>` `
}) })
class DocumentListDemo { class DocumentListDemo {
@@ -162,17 +161,13 @@ export class AppModule {
} }
platformBrowserDynamic().bootstrapModule(AppModule); platformBrowserDynamic().bootstrapModule(AppModule);
``` ```
### Properties ### Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `rootFolderId` | string | -root- | Root node ID, i.e. `-root-`, `-shared-`, `-my-`, etc. or a fixed node ID | | `currentFolderId` | string | null | Initial node ID of displayed folder. Can be `-root-`, `-shared-`, `-my-`, or a fixed node ID |
| `currentFolderPath` | string | null | Initial path of displayed folder below the root node, e.g. "/Sites/swsdp/documentLibrary" |
| `currentFolderId` | string | null | Initial node ID of displayed folder, if given |
| `navigate` | boolean | true | Toggles navigation to folder content or file preview | | `navigate` | boolean | true | Toggles navigation to folder content or file preview |
| `navigationMode` | string (click\|dblclick) | dblclick | User interaction for folder navigation or file preview | | `navigationMode` | string (click\|dblclick) | dblclick | User interaction for folder navigation or file preview |
| `thumbnails` | boolean | false | Show document thumbnails rather than icons | | `thumbnails` | boolean | false | Show document thumbnails rather than icons |
@@ -193,7 +188,6 @@ platformBrowserDynamic().bootstrapModule(AppModule);
| `folderChange` | Emitted upon display folder changed | | `folderChange` | Emitted upon display folder changed |
| `preview` | Emitted when document preview is requested either with single or double click | | `preview` | Emitted when document preview is requested either with single or double click |
_For a complete example source code please refer to _For a complete example source code please refer to
[DocumentList Demo](https://github.com/Alfresco/alfresco-ng2-components/tree/master/ng2-components/ng2-alfresco-documentlist/demo) [DocumentList Demo](https://github.com/Alfresco/alfresco-ng2-components/tree/master/ng2-components/ng2-alfresco-documentlist/demo)
repository._ repository._
@@ -204,7 +198,8 @@ DocumentList provides simple breadcrumb element to indicate the current position
```html ```html
<alfresco-document-list-breadcrumb <alfresco-document-list-breadcrumb
[target]="documentList"> [target]="documentList"
[folderNode]="documentList.folderNode">
</alfresco-document-list-breadcrumb> </alfresco-document-list-breadcrumb>
``` ```