From 31235c9f521aba46377fe5de099fb2f9af6e7b65 Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Fri, 27 Oct 2017 14:48:59 +0100 Subject: [PATCH] rename 'info-drawer' to 'sidebar' (#2562) --- .../file-view/file-view.component.html | 2 +- docs/viewer.component.md | 18 +++++++++--------- ng2-components/ng2-alfresco-viewer/index.ts | 4 ++-- ...omponent.ts => viewer-sidebar.component.ts} | 6 +++--- .../src/components/viewer.component.html | 14 +++++++------- .../src/components/viewer.component.scss | 2 +- .../src/components/viewer.component.spec.ts | 18 +++++++++--------- .../src/components/viewer.component.ts | 10 +++++----- 8 files changed, 37 insertions(+), 37 deletions(-) rename ng2-components/ng2-alfresco-viewer/src/components/{viewer-info-drawer.component.ts => viewer-sidebar.component.ts} (87%) diff --git a/demo-shell-ng2/src/app/components/file-view/file-view.component.html b/demo-shell-ng2/src/app/components/file-view/file-view.component.html index 9946183090..844dc06122 100644 --- a/demo-shell-ng2/src/app/components/file-view/file-view.component.html +++ b/demo-shell-ng2/src/app/components/file-view/file-view.component.html @@ -1,5 +1,5 @@ - + diff --git a/docs/viewer.component.md b/docs/viewer.component.md index a3b6a7157b..e967651dfa 100644 --- a/docs/viewer.component.md +++ b/docs/viewer.component.md @@ -54,8 +54,8 @@ Using with file url: | allowDownload | boolean | true | Toggle download feature | | allowPrint | boolean | false | Toggle printing feature | | allowShare | boolean | false | Toggle sharing feature | -| allowInfoDrawer | boolean |false | Toogle info drawer feature | -| showInfoDrawer | boolean | false | Toggles info drawer visibility. Requires `allowInfoDrawer` to be set to `true`. | +| allowSidebar | boolean |false | Toogle sidebar feature | +| showSidebar | boolean | false | Toggles sidebar visibility. Requires `allowSidebar` to be set to `true`. | ## Events @@ -131,20 +131,20 @@ You can replace standard viewer toolbar with your custom implementation. Everything you put inside the "adf-viewer-toolbar" tags is going to be rendered instead of the toolbar. -### Custom info drawer +### Custom sidebar -The Viewer component also suports custom Info Drawer components and layouts. -The `allowInfoDrawer` property should be set to `true` to enable Info Drawer feature. +The Viewer component also suports custom sidebar components and layouts. +The `allowSidebar` property should be set to `true` to enable this feature. ```html - - + +

My info

-
+
``` -Everything you put inside the "adf-viewer-info-drawer" tags is going to be rendered instead of the default info drawer. +Everything you put inside the "adf-viewer-sidebar" tags is going to be rendered instead of the default sidebar. ### Custom "Open With" menu diff --git a/ng2-components/ng2-alfresco-viewer/index.ts b/ng2-components/ng2-alfresco-viewer/index.ts index cb76e11ea6..66374509d8 100644 --- a/ng2-components/ng2-alfresco-viewer/index.ts +++ b/ng2-components/ng2-alfresco-viewer/index.ts @@ -24,9 +24,9 @@ import { MediaPlayerComponent } from './src/components/mediaPlayer.component'; import { PdfViewerComponent } from './src/components/pdfViewer.component'; import { TxtViewerComponent } from './src/components/txtViewer.component'; import { UnknownFormatComponent } from './src/components/unknown-format/unknown-format.component'; -import { ViewerInfoDrawerComponent } from './src/components/viewer-info-drawer.component'; import { ViewerMoreActionsComponent } from './src/components/viewer-more-actions.component'; import { ViewerOpenWithComponent } from './src/components/viewer-open-with.component'; +import { ViewerSidebarComponent } from './src/components/viewer-sidebar.component'; import { ViewerToolbarComponent } from './src/components/viewer-toolbar.component'; import { ViewerComponent } from './src/components/viewer.component'; import { ExtensionViewerDirective } from './src/directives/extension-viewer.directive'; @@ -44,7 +44,7 @@ export function declarations() { ExtensionViewerDirective, UnknownFormatComponent, ViewerToolbarComponent, - ViewerInfoDrawerComponent, + ViewerSidebarComponent, ViewerOpenWithComponent, ViewerMoreActionsComponent ]; diff --git a/ng2-components/ng2-alfresco-viewer/src/components/viewer-info-drawer.component.ts b/ng2-components/ng2-alfresco-viewer/src/components/viewer-sidebar.component.ts similarity index 87% rename from ng2-components/ng2-alfresco-viewer/src/components/viewer-info-drawer.component.ts rename to ng2-components/ng2-alfresco-viewer/src/components/viewer-sidebar.component.ts index 12ae201169..cd83ce84f1 100644 --- a/ng2-components/ng2-alfresco-viewer/src/components/viewer-info-drawer.component.ts +++ b/ng2-components/ng2-alfresco-viewer/src/components/viewer-sidebar.component.ts @@ -18,11 +18,11 @@ import { ChangeDetectionStrategy, Component, ViewEncapsulation } from '@angular/core'; @Component({ - selector: 'adf-viewer-info-drawer', + selector: 'adf-viewer-sidebar', encapsulation: ViewEncapsulation.None, changeDetection: ChangeDetectionStrategy.OnPush, - host: { class: 'adf-viewer-info-drawer' }, + host: { class: 'adf-viewer-sidebar' }, template: `` }) -export class ViewerInfoDrawerComponent { +export class ViewerSidebarComponent { } diff --git a/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.html b/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.html index 4d9f25ea5d..dee55dae7e 100644 --- a/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.html +++ b/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.html @@ -68,12 +68,12 @@
- + @@ -127,10 +127,10 @@ - -
- - + +
+ +
diff --git a/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.scss b/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.scss index 120dcf4a2e..80466233ea 100644 --- a/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.scss +++ b/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.scss @@ -84,7 +84,7 @@ $adf-viewer-background-color: #f5f5f5; } } - &__info-drawer { + &__sidebar { width: 350px; display: block; padding: 8px 0; diff --git a/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.spec.ts b/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.spec.ts index 40e7c90938..450cc0b043 100644 --- a/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.spec.ts +++ b/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.spec.ts @@ -30,9 +30,9 @@ import { MediaPlayerComponent } from './mediaPlayer.component'; import { PdfViewerComponent } from './pdfViewer.component'; import { TxtViewerComponent } from './txtViewer.component'; import { UnknownFormatComponent } from './unknown-format/unknown-format.component'; -import { ViewerInfoDrawerComponent } from './viewer-info-drawer.component'; import { ViewerMoreActionsComponent } from './viewer-more-actions.component'; import { ViewerOpenWithComponent } from './viewer-open-with.component'; +import { ViewerSidebarComponent } from './viewer-sidebar.component'; import { ViewerToolbarComponent } from './viewer-toolbar.component'; import { ViewerComponent } from './viewer.component'; @@ -51,16 +51,16 @@ declare let jasmine: any; class ViewerWithCustomToolbarComponent {} @Component({ - selector: 'adf-viewer-container-info-drawer', + selector: 'adf-viewer-container-sidebar', template: ` - -
-
+ +
+
` }) -class ViewerWithCustomInfoDrawerComponent {} +class ViewerWithCustomSidebarComponent {} @Component({ selector: 'adf-viewer-container-open-with', @@ -128,12 +128,12 @@ describe('ViewerComponent', () => { MediaPlayerComponent, ImgViewerComponent, UnknownFormatComponent, - ViewerInfoDrawerComponent, + ViewerSidebarComponent, ViewerToolbarComponent, ViewerOpenWithComponent, ViewerMoreActionsComponent, ViewerWithCustomToolbarComponent, - ViewerWithCustomInfoDrawerComponent, + ViewerWithCustomSidebarComponent, ViewerWithCustomOpenWithComponent, ViewerWithCustomMoreActionsComponent ], @@ -173,7 +173,7 @@ describe('ViewerComponent', () => { }); it('should use custom info drawer', () => { - let customFixture = TestBed.createComponent(ViewerWithCustomInfoDrawerComponent); + let customFixture = TestBed.createComponent(ViewerWithCustomSidebarComponent); let customElement: HTMLElement = customFixture.nativeElement; customFixture.detectChanges(); diff --git a/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.ts b/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.ts index 612853c1b7..92a4a22438 100644 --- a/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.ts +++ b/ng2-components/ng2-alfresco-viewer/src/components/viewer.component.ts @@ -23,9 +23,9 @@ import { import { MinimalNodeEntryEntity } from 'alfresco-js-api'; import { AlfrescoApiService, BaseEvent, LogService, RenditionsService } from 'ng2-alfresco-core'; -import { ViewerInfoDrawerComponent } from './viewer-info-drawer.component'; import { ViewerMoreActionsComponent } from './viewer-more-actions.component'; import { ViewerOpenWithComponent } from './viewer-open-with.component'; +import { ViewerSidebarComponent } from './viewer-sidebar.component'; import { ViewerToolbarComponent } from './viewer-toolbar.component'; @Component({ @@ -40,8 +40,8 @@ export class ViewerComponent implements OnDestroy, OnChanges { @ContentChild(ViewerToolbarComponent) toolbar: ViewerToolbarComponent; - @ContentChild(ViewerInfoDrawerComponent) - infoDrawer: ViewerInfoDrawerComponent; + @ContentChild(ViewerSidebarComponent) + sidebar: ViewerSidebarComponent; @ContentChild(ViewerOpenWithComponent) mnuOpenWith: ViewerOpenWithComponent; @@ -83,10 +83,10 @@ export class ViewerComponent implements OnDestroy, OnChanges { allowShare = false; @Input() - allowInfoDrawer = false; + allowSidebar = false; @Input() - showInfoDrawer = false; + showSidebar = false; @Output() goBack = new EventEmitter>();