# ngx-airfieldhub
> This library is a wrapper for Angular 9+ websites and apps to integrate AirfieldHub seamlessly into your existing system.
Latest version **1.0.9** (published 2022-11-01) · BSD-4-Clause license · 0 weekly downloads
## Install
```sh
npm install ngx-airfieldhub
pnpm add ngx-airfieldhub
yarn add ngx-airfieldhub
bun add ngx-airfieldhub
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.9 |
| Published | 2022-11-01 |
| First published | 2022-10-14 |
| Weekly downloads | 0 |
| License | BSD-4-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 155 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Airfield Hub |
| Maintainers | airfieldhubalex |
| Keywords | airfieldhub, airfield hub, ngx-airfieldhub, airfield hub angular, simple ppr, ppr forms, aviation |
## Links
- npm: https://www.npmjs.com/package/ngx-airfieldhub
- Homepage: https://github.com/airfieldhub/ngx-airfieldhub
- npm.io page: https://npm.io/package/ngx-airfieldhub
## Dependencies (1)
- [tslib](https://npm.io/package/tslib.md) ^2.3.0
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 1.0.9 (latest) — 2022-11-01
- 1.0.8 — 2022-11-01
- 1.0.7 — 2022-11-01
- 1.0.6 — 2022-11-01
- 1.0.5 — 2022-10-25
- 1.0.0 — 2022-10-25
- 0.0.2 — 2022-10-20
- 0.0.1 — 2022-10-14
## README
# 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:
```
```
To show the BOOKOUT form:
```
```
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.
---
Copyright (c) 2022, AirfieldHub LTD
All rights reserved.
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.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ''AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
---
_Source: https://npm.io/package/ngx-airfieldhub · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._