Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/j-siu/ng2-simple-global

A simple global variable service for Angular 2
https://github.com/j-siu/ng2-simple-global

angular angular-2 angular2 global ng2

Last synced: about 2 months ago
JSON representation

A simple global variable service for Angular 2

Host: GitHub
URL: https://github.com/j-siu/ng2-simple-global
Owner: J-Siu
License: mit
Archived: true
Created: 2016-10-07T02:45:27.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2022-05-16T16:58:18.000Z (over 2 years ago)
Last Synced: 2024-09-27T17:21:37.642Z (about 2 months ago)
Topics: angular, angular-2, angular2, global, ng2
Language: TypeScript
Homepage:
Size: 11.7 KB
Stars: 6
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Angular Simple Global [![Paypal donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/donate/?business=HZF49NM9D35SJ&no_recurring=0&currency_code=CAD)

A simple global variable service for Angular.

> To enable faster update, ng2-simple-global switched to Angular CLI starting 8.2.0 and use new repository https://github.com/J-Siu/ng2-simple-global-lib/

>

> Project contains both library and example.

>

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

### Table Of Content

- [Install](#install)

- [Usage](#usage)

  - [Import into Angular 2 application typescript](#import-into-angular-2-application-typescript)

  - [API](#api)

- [Repository](#repository)

- [Example](#example)

- [Contributors](#contributors)

- [Changelog](#changelog)

- [License](#license)

### Install

```

npm install ng2-simple-global

```

### Usage

#### Import into Angular 2 application (typescript)

`ng2-simple-global` is implemented as Angular 2 injectable service name __SimpleGlobal__.

__For module using SimpleGlobal__

Add `SimpleGlobal` into module providers.

```javascript

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

@NgModule({

	providers: [SimpleGlobal]

})

```

__For each child component using SimpleGlobal__

```javascript

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

export class ChildComponent {

	constructor(private sg: SimpleGlobal) { }

}

```

#### API

```javascript

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

@Component({

	selector: 'child-com',

	template: `

		
This is a global variable: {{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.

### Repository

[ng2-simple-global](https://github.com/J-Siu/ng2-simple-global)

### Example

[ng2-simple-global-example](https://github.com/J-Siu/ng2-simple-global-example)

[plunker](http://plnkr.co/J4GvVp)

### Contributors

* [John Sing Dao Siu](https://github.com/J-Siu)

### 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.

### License

The MIT License

Copyright (c) 2017

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.