[ADF-2097] Sidebar Action Menu - New component (#2813)

SidebarMenu Component

demo-shell/src/app/components/process-service/process-service.component.html

@@ -4,10 +4,14 @@
             <div class="adf-grid" fxLayout="row" fxLayout.lt-lg="column" fxLayoutAlign="stretch">
                 <div class="adf-grid-item adf-tasks-menu" fxFlex.gt-md="225px">
                     <div class="adf-list-buttons">
-                        <button color="primary" mat-raised-button data-automation-id="btn-start-task" class="adf-list-buttons-start" (click)="navigateStartTask()">
+                        <adf-sidebar-action-menu [expanded]="true" title="{{'ADF_SIDEBAR_ACTION_MENU.BUTTON.CREATE' | translate}}">
-                            <mat-icon>add</mat-icon>
+                            <mat-icon sidebar-menu-title-icon >arrow_drop_down</mat-icon>
-                            <span>{{'PS-TAB.START-TASK' | translate}}</span>
+                                <div sidebar-menu-options>
-                        </button>
+                                    <button mat-menu-item data-automation-id="btn-start-task" (click)="navigateStartTask()">
+                                        <span>{{'ADF_SIDEBAR_ACTION_MENU.BUTTON.NEW_TASK' | translate}}</span>
+                                    </button>
+                                </div>
+                        </adf-sidebar-action-menu>
                     </div>
                     <adf-accordion>
                         <adf-accordion-group [heading]="'Tasks'" [isSelected]="true" [isOpen]="true"
@@ -105,15 +109,14 @@
             <div class="adf-grid" fxLayout="row" fxLayout.lt-lg="column" fxLayoutAlign="stretch">
                 <div class="adf-grid-item adf-processes-menu" fxFlex.gt-md="225px">
                     <div class="adf-list-buttons">
-                        <button
+                        <adf-sidebar-action-menu [expanded]="true" title="{{'ADF_SIDEBAR_ACTION_MENU.BUTTON.CREATE' | translate}}">
-                            color="primary"
+                            <mat-icon sidebar-menu-title-icon >arrow_drop_down</mat-icon>
-                            mat-raised-button
+                            <div sidebar-menu-options>
-                            class="adf-list-buttons-start"
+                                <button mat-menu-item data-automation-id="btn-start-process" (click)="navigateStartProcess()">
-                            data-automation-id="btn-start-process"
+                                    <span>{{'ADF_SIDEBAR_ACTION_MENU.BUTTON.NEW_PROCESS' | translate}}</span>
-                            (click)="navigateStartProcess()">
+                                </button>
-                            <mat-icon>add</mat-icon>
+                            </div>
-                            <span>{{'PS-TAB.START-PROCESS' | translate}}</span>
+                        </adf-sidebar-action-menu>
-                        </button>
                     </div>
                     <adf-accordion>
                         <adf-accordion-group [heading]="'Processes'" [isSelected]="true" [isOpen]="true"

docs/sidebar-action-menu.component.md

@@ -0,0 +1,38 @@
+# Sidebar action menu component
+
+Displays a sidebar-action menu information panel.
+
+![Sidebar action menu button screenshot](docassets/images/sidebar-action-menu-button.png)
+![Sidebar action menu icon screenshot](docassets/images/sidebar-action-menu-icon.png)
+
+## Basic usage
+
+```html
+<adf-sidebar-action-menu>
+    <mat-icon sidebar-menu-title-icon>arrow_drop_down</mat-icon>
+    <div sidebar-menu-expand-icon>
+        <mat-icon>queue</mat-icon>
+    </div>
+    <div sidebar-menu-options>
+        <button mat-menu-item>
+            <mat-icon>assignment</mat-icon>
+            <span>Button Name</span>
+        </button>
+    </div>
+</adf-sidebar-action-menu>
+```
+
+### Properties
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| title | string | null | The title of the Sidebar action |
+| expanded | boolean | false | Toggle the sidebar action menu on expand.
+## Details
+
+As the name suggests, this is basically just a layout with CSS styling. There are three regions where you can add your own content, as shown in the example:
+
+- sidebar-menu-title-icon
+- sidebar-menu-options
+- sidebar-menu-expand-icon
+

lib/core/core.module.ts

@@ -41,6 +41,7 @@ import { ToolbarModule } from './toolbar/toolbar.module';
 import { UserInfoModule } from './userinfo/userinfo.module';
 import { ViewerModule } from './viewer/viewer.module';
 import { FormModule } from './form/form.module';
+import { SideBarActionModule } from './sidebar/sidebar-action.module';
 
 import { DirectiveModule } from './directives/directive.module';
 import { PipeModule } from './pipes/pipe.module';
@@ -55,6 +56,7 @@ export function createTranslateLoader(http: HttpClient, logService: LogService)
 @NgModule({
     imports: [
         ViewerModule,
+        SideBarActionModule,
         PipeModule,
         CommonModule,
         DirectiveModule,
@@ -113,6 +115,7 @@ export function createTranslateLoader(http: HttpClient, logService: LogService)
         HostSettingsModule,
         ServiceModule,
         ViewerModule,
+        SideBarActionModule,
         PipeModule,
         DirectiveModule,
         FormModule,

lib/core/index.ts

@@ -45,6 +45,7 @@ export * from './pagination';
 export * from './login';
 export * from './language-menu';
 export * from './info-drawer';
+export * from './sidebar';
 export * from './data-column';
 export * from './datatable';
 export * from './context-menu';

lib/core/sidebar/index.ts

@@ -0,0 +1,18 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './public-api';

lib/core/sidebar/public-api.ts

@@ -0,0 +1,18 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './sidebar-action-menu.component';

lib/core/sidebar/sidebar-action-menu.component.html

@@ -0,0 +1,16 @@
+<div class="adf-sidebar-action-menu">
+    <button *ngIf="isExpanded()" mat-raised-button class="adf-sidebar-action-menu-button" [matMenuTriggerFor]="adfSidebarMenu">
+        <span *ngIf="title" class="adf-sidebar-action-menu-text">{{ title }}</span>
+        <ng-content select="[sidebar-menu-title-icon]"></ng-content>
+    </button>
+
+    <div *ngIf="!isExpanded()" class="adf-sidebar-action-menu-icon" [matMenuTriggerFor]="adfSidebarMenu">
+        <ng-content select="[sidebar-menu-expand-icon]"></ng-content>
+    </div>
+
+    <mat-menu #adfSidebarMenu="matMenu" [overlapTrigger]="false" yPosition="below">
+        <div class="adf-sidebar-action-menu-options">
+            <ng-content select="[sidebar-menu-options]"></ng-content>
+        </div>
+    </mat-menu>
+</div>

lib/core/sidebar/sidebar-action-menu.component.scss

@@ -0,0 +1,71 @@
+@mixin  adf-sidebar-action-menu-theme($theme) {
+
+    $primary: map-get($theme, primary);
+    $foreground: map-get($theme, foreground);
+    $background: map-get($theme, background);
+
+    $adf-sidebar-action-menu-button-option-width: 205px;
+    $adf-sidebar-action-menu-button-height: 37.5px;
+    $adf-sidebar-action-menu-button-border-radius: 4px;
+    $adf-sidebar-action-menu-opacity: 0.54;
+    $adf-sidebar-action-menu-item-opacity: 0.87;
+    $adf-sidebar-action-menu-item-line-spacing: -0.4px;
+
+.adf {
+    &-sidebar-action-menu {
+        & .mat-raised-button {
+            width: 100%;
+            height: 37.5px;
+            font-weight: bold;
+            background-color: mat-color($primary);
+            color: mat-color($primary, default-contrast) !important;
+            border-radius: $adf-sidebar-action-menu-button-border-radius;
+            & mat-icon {
+                width: 24px;
+                height: 25px;
+                color: mat-color($primary, default-contrast) !important;
+            }
+        }
+        &-text {
+            width: 100%;
+            height: 20px;
+            text-align: left;
+        }
+    }
+    &-sidebar-action-menu-icon {
+        margin: 18px 0px 0px 20px;
+        opacity: $adf-sidebar-action-menu-opacity;
+        cursor: pointer;
+        &:hover {
+            color: mat-color($primary);
+            opacity: inherit;
+        }
+    }
+    &-sidebar-action-menu-options {
+        width: $adf-sidebar-action-menu-button-option-width;
+        opacity: 0.87;
+        text-align: left;
+        letter-spacing: -0.4px;
+        color: #000000;
+        .mat-menu-item {
+            width: $adf-sidebar-action-menu-button-option-width;
+            opacity: $adf-sidebar-action-menu-item-opacity;
+            text-align: left;
+            line-height: 1.5;
+            letter-spacing: $adf-sidebar-action-menu-item-line-spacing;
+            color: #000000;
+        }
+        .mat-menu-item:hover {
+            color: mat-color($primary);
+            opacity: inherit;
+        }
+    }
+}
+
+.mat-menu-panel {
+    margin-top: 7.5px;
+    border-radius: 2px;
+    background-color: mat-color($primary, default-contrast) !important;
+    box-shadow: 0 8px 8px 0 rgba(0, 0, 0, 0.26), 0 0 8px 0 rgba(0, 0, 0, 0.12);
+}
+}

lib/core/sidebar/sidebar-action-menu.component.spec.ts

@@ -0,0 +1,149 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Component } from '@angular/core';
+import { async, ComponentFixture, TestBed } from '@angular/core/testing';
+import { MaterialModule } from '../material.module';
+import { SidebarActionMenuComponent } from './sidebar-action-menu.component';
+
+describe('SidebarActionMenuComponent', () => {
+    let element: HTMLElement;
+    let component: SidebarActionMenuComponent;
+    let fixture: ComponentFixture<SidebarActionMenuComponent>;
+
+    beforeEach(async(() => {
+        TestBed.configureTestingModule({
+            declarations: [
+                SidebarActionMenuComponent
+            ],
+            imports: [
+                MaterialModule
+            ]
+        }).compileComponents();
+    }));
+
+    beforeEach(() => {
+        fixture = TestBed.createComponent(SidebarActionMenuComponent);
+        element = fixture.nativeElement;
+        component = fixture.componentInstance;
+    });
+
+    it('should create instance of SidebarActionMenuComponent', () => {
+        expect(fixture.componentInstance instanceof SidebarActionMenuComponent).toBe(true, 'should create SidebarActionMenuComponent');
+    });
+
+    it('should display title', () => {
+        component.title = 'Fake-Title';
+        component.expanded = true;
+        fixture.detectChanges();
+        const title = element.querySelector('.adf-sidebar-action-menu-text');
+        fixture.detectChanges();
+        expect(title.textContent).toBe('Fake-Title');
+    });
+});
+
+@Component({
+    template: `
+    <adf-sidebar-action-menu [expanded]="expanded" [title]="title">
+    <mat-icon sidebar-menu-title-icon>arrow_drop_down</mat-icon>
+    <div sidebar-menu-expand-icon>
+        <mat-icon>queue</mat-icon>
+    </div>
+    <div sidebar-menu-options>
+        <button mat-menu-item>
+            <mat-icon>assignment</mat-icon>
+            <span>Option1</span>
+        </button>
+        <button mat-menu-item>
+            <mat-icon>assignment</mat-icon>
+            <span>Option2</span>
+        </button>
+    </div>
+</adf-sidebar-action-menu>
+       `
+})
+class CustomSidebarActionMenuComponent {
+    title: string = 'Fake title';
+    expanded: boolean = true;
+}
+
+describe('Custom SidebarActionMenuComponent', () => {
+    let fixture: ComponentFixture<CustomSidebarActionMenuComponent>;
+    let component: CustomSidebarActionMenuComponent;
+    let element: HTMLElement;
+
+    beforeEach(async(() => {
+        TestBed.configureTestingModule({
+            declarations: [
+                SidebarActionMenuComponent,
+                CustomSidebarActionMenuComponent
+            ],
+            imports: [
+                MaterialModule
+            ]
+        }).compileComponents();
+    }));
+
+    beforeEach(() => {
+        fixture = TestBed.createComponent(CustomSidebarActionMenuComponent);
+        fixture.detectChanges();
+        component = fixture.componentInstance;
+        element = fixture.nativeElement;
+    });
+
+    it('should create instance of CustomSidebarActionMenuComponent', () => {
+        expect(component instanceof CustomSidebarActionMenuComponent).toBe(true, 'should create CustomSidebarActionMenuComponent');
+    });
+
+    it('should defined adf-sidebar-action-menu', () => {
+        fixture.detectChanges();
+        element = fixture.nativeElement.querySelector('adf-sidebar-action-menu');
+        expect(element).toBeDefined();
+    });
+
+    it('should display the title', () => {
+        component.title = 'FakeTitle';
+        fixture.detectChanges();
+        const title = element.querySelector('.adf-sidebar-action-menu-text');
+        fixture.detectChanges();
+        expect(title.textContent).toBe('FakeTitle');
+    });
+
+    it('should render the sidebar-menu-options', () => {
+        fixture.detectChanges();
+        const actionButton = fixture.nativeElement.querySelector('.adf-sidebar-action-menu-button');
+        const options = fixture.nativeElement.querySelectorAll('.adf-sidebar-action-menu-options');
+        actionButton.click();
+        fixture.detectChanges();
+        fixture.whenStable().then(() => {
+            expect(actionButton).not.toBeNull();
+            expect(actionButton).toBeDefined();
+            expect(options).toBeDefined();
+            expect(actionButton.innerText.trim()).toBe('Fake title arrow_drop_down');
+        });
+    });
+
+    it('should show icon on icon menu', () => {
+        component.title = 'FakeTitle';
+        component.expanded = false;
+        fixture.detectChanges();
+        const actionIcon = fixture.nativeElement.querySelector('.adf-sidebar-action-menu-icon');
+        expect(actionIcon).not.toBeNull();
+        expect(actionIcon).toBeDefined();
+        expect(actionIcon.innerText.trim()).toBe('queue');
+    });
+});

lib/core/sidebar/sidebar-action-menu.component.ts

@@ -0,0 +1,44 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ChangeDetectionStrategy, Component, Directive, Input, ViewEncapsulation } from '@angular/core';
+
+@Component({
+    selector: 'adf-sidebar-action-menu',
+    templateUrl: './sidebar-action-menu.component.html',
+    styleUrls: ['./sidebar-action-menu.component.scss'],
+    changeDetection: ChangeDetectionStrategy.OnPush,
+    encapsulation: ViewEncapsulation.None,
+    host: { 'class': 'adf-sidebar-action-menu' }
+})
+
+export class SidebarActionMenuComponent {
+
+    @Input()
+    title: string;
+
+    @Input()
+    expanded: boolean;
+
+    isExpanded(): boolean {
+        return this.expanded;
+    }
+}
+
+@Directive({ selector: '[sidebar-menu-options]' }) export class SidebarMenuDirective {}
+@Directive({ selector: '[sidebar-menu-title-icon]' }) export class SidebarMenuTitleIconDirective { }
+@Directive({ selector: '[sidebar-menu-expand-icon]' }) export class SidebarMenuExpandIconDirective { }

lib/core/sidebar/sidebar-action.module.ts

@@ -0,0 +1,38 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { CommonModule } from '@angular/common';
+import { FlexLayoutModule } from '@angular/flex-layout';
+import { NgModule } from '@angular/core';
+import { MaterialModule } from '../material.module';
+
+import { SidebarActionMenuComponent } from './sidebar-action-menu.component';
+
+@NgModule({
+    imports: [
+        CommonModule,
+        MaterialModule,
+        FlexLayoutModule
+    ],
+    declarations: [
+        SidebarActionMenuComponent
+    ],
+    exports: [
+        SidebarActionMenuComponent
+    ]
+})
+export class SideBarActionModule {}

lib/core/styles/_index.scss

@@ -18,6 +18,7 @@
 @import '../userinfo/components/user-info.component';
 @import '../viewer/components/viewer.component';
 @import '../form/components/form.component';
+@import '../sidebar/sidebar-action-menu.component';
 
 @mixin adf-core-theme($theme) {
     @include adf-colors-theme($theme);
@@ -37,7 +38,8 @@
     @include adf-toolbar-theme($theme);
     @include adf-userinfo-theme($theme);
     @include adf-viewer-theme($theme);
-    @include adf-form-component-theme($theme)
+    @include adf-form-component-theme($theme);
+    @include adf-sidebar-action-menu-theme($theme);
 }
 
 

lib/process-services/i18n/de.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "Erstellt am"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "Erstellen",
+      "NEW_TASK": "Neue Aufgabe",
+      "NEW_PROCESS": "Neuer Prozess"
+    }
   }
 }

lib/process-services/i18n/en.json

@@ -295,5 +295,12 @@
         "CREATED-ON": "Created on"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "CREATE",
+      "NEW_TASK": "New Task",
+      "NEW_PROCESS": "New Process"
+    }
   }
 }

lib/process-services/i18n/es.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "Creado"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "Crear",
+      "NEW_TASK": "Nueva tarea",
+      "NEW_PROCESS": "Nuevo proceso"
+    }
   }
 }

lib/process-services/i18n/fr.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "Créé le"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "Créer",
+      "NEW_TASK": "Nouvelle tâche",
+      "NEW_PROCESS": "Nouveau processus"
+    }
   }
 }

lib/process-services/i18n/it.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "Creato il"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "Crea",
+      "NEW_TASK": "Nuovo compito",
+      "NEW_PROCESS": "Nuovo processo"
+    }
   }
 }

lib/process-services/i18n/ja.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "作成日"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "作成",
+      "NEW_TASK": "新しいタスク",
+      "NEW_PROCESS": "新しいプロセス"
+    }
   }
 }

lib/process-services/i18n/nb.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "Opprettet"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "Opprett",
+      "NEW_TASK": "Ny oppgave",
+      "NEW_PROCESS": "Ny prosess"
+    }
   }
 }

lib/process-services/i18n/nl.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "Gemaakt op"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "Maken",
+      "NEW_TASK": "Nieuwe taak",
+      "NEW_PROCESS": "Nieuw proces"
+    }
   }
 }

lib/process-services/i18n/pt-BR.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "Criado em"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "Criar",
+      "NEW_TASK": "Nova tarefa",
+      "NEW_PROCESS": "Novo processo"
+    }
   }
 }

lib/process-services/i18n/ru.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "Дата создания"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "Создать",
+      "NEW_TASK": "Новая задача",
+      "NEW_PROCESS": "Нов. процесс"
+    }
   }
 }

lib/process-services/i18n/zh-CN.json

@@ -294,5 +294,12 @@
         "CREATED-ON": "创建日期"
       }
     }
+  },
+  "ADF_SIDEBAR_ACTION_MENU": {
+    "BUTTON": {
+      "CREATE": "创建",
+      "NEW_TASK": "新任务",
+      "NEW_PROCESS": "新流程"
+    }
   }
 }