Ngx-airfieldhub NPM

Angular AirfieldHub (ngx-airfieldhub)

This library is a wrapper for Angular 9+ websites and apps to integrate AirfieldHub seamlessly into your existing system.

AirfieldHub aims to take all the pain out of PPR (Prior Permission Required) for both pilots and airfield, in addition to a myriad of other features for airfields.

This version of the library creates two new tags, allowing you to display your AirfieldHub PPR and Bookout forms on your own website without having to code anything yourself.

Our philosophy at AirfieldHub is that everything should be simple and straight forward, making all our lives easier, hence this simple library ensuring that you can be up and running with AirfieldHub with the least amount of pain possible.

Installation

Using NPM

npm install ngx-airfieldhub --save

Using YARN

yarn add ngx-airfieldhub

Initial Setup

First: your app.module file; You will need to import your environment file (if not already imported) and ngx-airfieldhub. You will then need to initialise AirfieldHub in your @NgModule as follows.

import { environment } from './../environments/environment';

import { NgxAirfieldhubModule } from 'ngx-airfieldhub';

...

@NgModule({
  ...
  imports: [
    ...

    NgxAirfieldhubModule.forRoot({airfieldhub_key: environment.airfieldhub_key})
  
  ],
  ...
})

NOTE: your airfieldhub_key comes from your AirfieldHub account, you can find this by clicking Dashboard on the top right of our user interface, then Widget on the menu on the left hand side of the screen.

Second: your angular.json file; You will need to include our asset folder in your assets build option script. You do this by copy & pasting the code below:

	{
     "glob": "**/*",
     "input": "./node_modules/ngx-airfieldhub/assets",
     "output": "/assets/"
   	}

Into your "assets" tag inside "options" inside "build" inside "architect" ie:

{
  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
  
  ...

  "projects": {
    "name_of_your_application": {
      
      ...
      
      "architect": {
        "build": {
          "builder": "@angular-devkit/build-angular:browser",
          "options": {
            
            ...

            "assets": [
              "src/favicon.ico",
              "src/assets",

              {
                 "glob": "**/*",
                 "input": "./node_modules/ngx-airfieldhub/assets",
                 "output": "/assets/"
               }
            
            ],

            ...
            
          },

    ...

This will inject a JS file onto the page(s) on which you include our library, allowing our widgets to appear correctly.

If you do not require the usage of an environment file, feel free to enter the key directly in your app.module files instead of environment.airfieldhub_key by wrapping the key as a string, ie: "my_airfieldhub_key"

Usage

Once the AirfieldHub library has been installed following the instructions above, you will then be able to include the forms by going directly in the template of the page you wish for it to appear:

To show the PPR form:

<airfieldhub-ppr></airfieldhub-ppr>

To show the BOOKOUT form:

<airfieldhub-bookout></airfieldhub-bookout>

This will span the whole width of the parent item, and will automatically extend the height of the element to ensure no scrolling is necessary.

Further help

To get more help on this library, please feel free to contact us directly through AirfieldHub (https://airfieldhub.com/contact) and we will respond as quickly as we can.

Should you find any particular issues, please feel free to open a new issue!

We will endeavour to update this library periodically, as and when it is required by our clients, and when new features become available.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by AirfieldHub LTD. 4. Neither the name of the AirfieldHub LTD nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.