Angular Simple Global Variable Service

Table of Contents

ng2-simple-global is a global variable service for Angular.

ng2-simple-global uses Angular CLI starting 8.2.0. New repository https://github.com/J-Siu/ng2-simple-global-lib/ contains both library and example.

Version < 8.2.0 are in old repository https://github.com/J-Siu/ng2-simple-global/

Install

npm install ng2-simple-global

Usage

ng2-simple-global is implemented as Angular injectable service name SimpleGlobal.

Module

Add SimpleGlobal into module providers.

import { SimpleGlobal } from 'ng2-simple-global';

@NgModule({
    providers: [SimpleGlobal]
})

Component

import {SimpleGlobal} from 'ng2-simple-global';

export class ChildComponent {

    constructor(private sg: SimpleGlobal) { }

}

API

import {SimpleGlobal} from 'ng2-simple-global';

@Component({
    selector: 'child-com',
    template: `
        <p>This is a global variable: {{sg.gv}}</p>
        <input type="text" [(ngModel)]="sg.gv">
    `
})
export class ChildComponent {

    localVar;

    constructor(private sg: SimpleGlobal) {
        if (this.sg['gv']) {
            this.localVar = this.sg['gv'];
        }
    }

}

Treat SimpleGlobal instance as a global object and create/assign additional attributes freely, and it will be accessible to all component using the service.

Example

You will need Angular CLI to build the library and run the example.

git clone https://github.com/J-Siu/ng2-simple-global-lib.git
cd ng2-simple-global-lib
npm i
ng build ng2-simple-global
ng serve --open

Repository

Contributors

Changelog

  • 1.2.0
    • Support Angular ^2.0.0
    • Clean up package
  • 1.2.1
    • Add license file
    • Add punker example
  • 1.2.2
    • Update package.json
    • Update Readme.md
  • 1.2.3
    • Support Angular2 ^2.4.1
  • 1.2.4
    • Due to the rapid release cycle of Angular, to minimize update purely due to peerDependencies, it is modified as follow: "peerDependencies": { "@angular/core": ">=2.4.0" }
  • 1.2.5
    • Update to support Angular 4.3.1. Please use previous version for Angular 2.x.x.
  • 8.2.0
    • Support Angular 8.2.0
    • Switch to Angular Cli for faster update.
    • Include example
  • 8.2.1
    • README.md clean up

License

The MIT License

Copyright (c) 2019

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

John Siu
Minimize the Effort, Maximize the Effect!
comments powered by Disqus