mgr/dashboard: Add helper component

Signed-off-by: Ricardo Marques <rimarques@suse.com>

diff --git a/src/pybind/mgr/dashboard/HACKING.rst b/src/pybind/mgr/dashboard/HACKING.rst
index 2a33e022837f294594789e6dd8a1aeaef207bb6e..6dc5fae628c9b08034fbf10dc7fca9546a86883b 100644 (file)
--- a/src/pybind/mgr/dashboard/HACKING.rst
+++ b/src/pybind/mgr/dashboard/HACKING.rst
@@ -120,6 +120,25 @@ Example:
     import { Credentials } from '../../../shared/models/credentials.model';
     import { HostService } from './services/host.service';
 
+Frontend components
+~~~~~~~~~~~~~~~~~~~
+
+There are several components that can be reused on different pages.
+This components are declared on the components module:
+`src/pybind/mgr/dashboard/frontend/src/app/shared/components`.
+
+Helper
+......
+
+This component should be used to provide additional information to the user.
+
+Example:
+
+.. code:: html
+
+    <cd-helper>
+      Some <strong>helper</strong> html text
+    </cd-helper>
 
 Backend Development
 -------------------

diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/components.module.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/components.module.ts
index fe65bea599bb1523e529891d1121b15902150e2a..7094e1e24cc52a7f06a0ab12e7b53d5fde010698 100644 (file)
--- a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/components.module.ts
+++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/components.module.ts
@@ -2,8 +2,9 @@ import { CommonModule } from '@angular/common';
 import { NgModule } from '@angular/core';
 
 import { ChartsModule } from 'ng2-charts/ng2-charts';
-import { AlertModule } from 'ngx-bootstrap';
+import { AlertModule, PopoverModule } from 'ngx-bootstrap';
 
+import { HelperComponent } from './helper/helper.component';
 import { SparklineComponent } from './sparkline/sparkline.component';
 import { ViewCacheComponent } from './view-cache/view-cache.component';
 
@@ -11,16 +12,19 @@ import { ViewCacheComponent } from './view-cache/view-cache.component';
   imports: [
     CommonModule,
     AlertModule.forRoot(),
+    PopoverModule.forRoot(),
     ChartsModule
   ],
   declarations: [
     ViewCacheComponent,
-    SparklineComponent
+    SparklineComponent,
+    HelperComponent
   ],
   providers: [],
   exports: [
     ViewCacheComponent,
-    SparklineComponent
+    SparklineComponent,
+    HelperComponent
   ]
 })
 export class ComponentsModule { }

diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.html b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.html
new file mode 100644 (file)
index 0000000..408e47c
--- /dev/null
+++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.html
@@ -0,0 +1,11 @@
+<ng-template #popoverTpl>
+  <div [innerHtml]="html"></div>
+  <ng-content></ng-content>
+</ng-template>
+<i class="fa fa-question-circle"
+   aria-hidden="true"
+   [popover]="popoverTpl"
+   placement="bottom"
+   container="body"
+   [outsideClick]="true">
+</i>

diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.scss b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.scss
new file mode 100644 (file)
index 0000000..a26cbbb
--- /dev/null
+++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.scss
@@ -0,0 +1,6 @@
+@import '../../../../defaults';
+
+i {
+  color: $oa-color-blue;
+  cursor: pointer;
+}

diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.spec.ts
new file mode 100644 (file)
index 0000000..1c29c50
--- /dev/null
+++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.spec.ts
@@ -0,0 +1,28 @@
+import { async, ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { PopoverModule } from 'ngx-bootstrap';
+
+import { HelperComponent } from './helper.component';
+
+describe('HelperComponent', () => {
+  let component: HelperComponent;
+  let fixture: ComponentFixture<HelperComponent>;
+
+  beforeEach(async(() => {
+    TestBed.configureTestingModule({
+      imports: [ PopoverModule.forRoot() ],
+      declarations: [ HelperComponent ]
+    })
+    .compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(HelperComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});

diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.ts
new file mode 100644 (file)
index 0000000..2fc9eba
--- /dev/null
+++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/helper/helper.component.ts
@@ -0,0 +1,14 @@
+import { Component, Input } from '@angular/core';
+
+@Component({
+  selector: 'cd-helper',
+  templateUrl: './helper.component.html',
+  styleUrls: ['./helper.component.scss']
+})
+export class HelperComponent {
+
+  @Input() html: any;
+
+  constructor() { }
+
+}

diff --git a/src/pybind/mgr/dashboard/frontend/src/openattic-theme.scss b/src/pybind/mgr/dashboard/frontend/src/openattic-theme.scss
index aa819a2f49e07293920f0b6fec32cd80054c6184..d4eee695ac8eb3692ca67510a98e1ad12296ee2c 100755 (executable)
--- a/src/pybind/mgr/dashboard/frontend/src/openattic-theme.scss
+++ b/src/pybind/mgr/dashboard/frontend/src/openattic-theme.scss
@@ -1078,12 +1078,6 @@ uib-accordion .panel-title,
   color: #d04437;
 }
 
-/* oa-helper  */
-oa-helper i {
-  color: $oa-color-blue;
-  cursor: pointer;
-}
-
 .page-footer {
   font-size: 12px;
   color: #777;