PDBe-KB Header Component

This repository is for the codebase of a lightweight Angular v7 web component that provides a header/banner and some basic navigation.

This component is used on the PDBe-KB Aggregated Views of Proteins and PDBe-KB Aggregated Views of Ligands.

Important: This web component depends on the "search-autocomplete" component which is available from https://github.com/PDBeurope/pdbe-autocomplete-search

Example:

Quick Start

Get the code and install dependencies

git clone https://github.com/PDBe-KB/component-pdbe-kb-header.git
cd component-pdbe-kb-header
npm i

Running the app

ng serve

Running tests

ng test

Dependencies

This web component embeds another PDBe web component: https://github.com/PDBeurope/pdbe-autocomplete-search

In order to use all the features of this web component, retrieve the search-autocomplete component and replace the contents of the src/app/seach-autocomplete folder with those files.

The main template (i.e. index.html by default) should also have the following CSS imports:

<link rel="stylesheet" href="https://ebi.emblstatic.net/web_guidelines/EBI-Framework/v1.3/css/ebi-global.css" type="text/css" media="all"/>
<link rel="stylesheet" href="https://ebi.emblstatic.net/web_guidelines/EBI-Icon-fonts/v1.3/fonts.css" type="text/css" media="all"/>
<link rel="stylesheet" href="https://ebi.emblstatic.net/web_guidelines/EBI-Framework/v1.3/css/theme-pdbe-green.css" type="text/css" media="all"/>

Basic usage

The component can be added to any Angular v7 apps.

1.) Import the component:

Import the component in app.module.ts by default.

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';
import { AppHeaderComponent } from './app-header/app-header.component';
import { SearchAutocompleteComponent } from './search-autocomplete/search-autocomplete.component';

@NgModule({
  declarations: [
    AppComponent,
    AppHeaderComponent,
    SearchAutocompleteComponent
  ],
  imports: [
    BrowserModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

2.) Add the component to a template:

<app-header [data]="headerData"></app-header>

The data model for the input data is described in src/app/app-header/app-header.models.ts

Example input data

[
  {
    label: 'Summary',
    icon_class: 'icon-generic',
    icon_data_icon: 'H',
    section_div_id: 'summary',
    counts: null,
    description: ''
  }
]

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Mihaly Varadi - Initial Implementation - mvaradi

See also the list of contributors who participated in this project.

License

This project is licensed under the EMBL-EBI License - see the LICENSE file for details

Acknowledgements

We would like to thank the PDBe team and the PDBe-KB partner resources for their feedback and contributions.