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

Update viewer documentation (#2763)

Browse Source
This commit is contained in:
Popovics András
2017-12-04 22:03:13 +00:00
committed by Eugenio Romano
parent 4462486df1
commit f341137b06
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/viewer.component.md
View File

@@ -58,6 +58,7 @@ Using with file url:
| allowSidebar | boolean |false | Toggle sidebar feature | | allowSidebar | boolean |false | Toggle sidebar feature |
| showSidebar | boolean | false | Toggles sidebar visibility. Requires `allowSidebar` to be set to `true`. | | showSidebar | boolean | false | Toggles sidebar visibility. Requires `allowSidebar` to be set to `true`. |
| sidebarPosition | string | right | The position of the sidebar. Can be `left` or `right`. | | sidebarPosition | string | right | The position of the sidebar. Can be `left` or `right`. |
| sidebarTemplate | TemplateRef<any> | null | The template intended to be used as a sidebar. The template context contains the loaded node data. |
## Events ## Events
@@ -174,6 +175,12 @@ Everything you put inside the "adf-viewer-toolbar" tags is going to be rendered
The Viewer component also supports custom sidebar components and layouts. The Viewer component also supports custom sidebar components and layouts.
The `allowSidebar` property should be set to `true` to enable this feature. The `allowSidebar` property should be set to `true` to enable this feature.
Custom sidebar for the viewer can be injected in two different ways:
- using transclusion
- using template **(only works when using the viewer with fileNodeId)**
#### Using transclusion
```html ```html
<adf-viewer [allowSidebar]="true"> <adf-viewer [allowSidebar]="true">
<adf-viewer-sidebar> <adf-viewer-sidebar>
@@ -182,7 +189,16 @@ The `allowSidebar` property should be set to `true` to enable this feature.
</adf-viewer> </adf-viewer>
``` ```
Everything you put inside the "adf-viewer-sidebar" tags is going to be rendered instead of the default sidebar. Everything you put inside the "adf-viewer-sidebar" tags is going to be rendered.
#### Using template injection (only works when using the viewer with fileNodeId)
```html
<ng-template let-node="node" #sidebarTemplate>
<adf-content-metadata-card [node]="node"></adf-content-metadata-card>
</ng-template>
<adf-viewer [allowSidebar]="true" [sidebarTemplate]="sidebarTemplate"></adf-viewer>
```
### Custom "Open With" menu ### Custom "Open With" menu