Skip to content

Commit

Permalink
update readme, version for 9.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
remackgeek committed Feb 9, 2020
1 parent 05813a5 commit 2bff72d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 13 deletions.
4 changes: 0 additions & 4 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,6 @@ jobs:
# Authenticate with registry
- run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > ~/repo/.npmrc

- run: echo "//registry.npmjs.org/:_authToken=$DUMMY_VAR" > ~/repo/foo

- run: cat ~/repo/foo

- run: ls -lsa

# deploy to npm
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

This library provides an Angular Elements Strategy Factory which always runs in the NgZone, allowing automatic change detection

![license](https://img.shields.io/npm/l/elements-zone-strategy.svg) ![downloads](https://img.shields.io/npm/dt/elements-zone-strategy.svg)
![license](https://img.shields.io/npm/l/elements-zone-strategy.svg) ![downloads](https://img.shields.io/npm/dt/elements-zone-strategy.svg)

This addresses the following issues with @angular/elements:
* [#23841 - elements: change detection breaks in *ngFor loop](https://github.com/angular/angular/issues/23841)
* [#24181 - @angular/elements component events are called from an inconsistent zone](https://github.com/angular/angular/issues/24181) -- This is fixed in zone.js v0.8.27

- [#23841 - elements: change detection breaks in \*ngFor loop](https://github.com/angular/angular/issues/23841)
- [#24181 - @angular/elements component events are called from an inconsistent zone](https://github.com/angular/angular/issues/24181) -- This is fixed in zone.js v0.8.27

## Usage

install the package:
install the package:

npm install --save elements-zone-strategy

Expand All @@ -22,3 +22,9 @@ use the new strategy:
const strategyFactory = new ElementZoneStrategyFactory(HelloComponent, this.injector);
const helloElement = createCustomElement(HelloComponent, { injector: this.injector, strategyFactory });
customElements.define('my-hello', helloElement);

## Versions

use version 9.0.0 for Angular 9

use version 8.0.0 for Angular 6-8
14 changes: 10 additions & 4 deletions projects/elements-zone-strategy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

This library provides an Angular Elements Strategy Factory which always runs in the NgZone, allowing automatic change detection

![license](https://img.shields.io/npm/l/elements-zone-strategy.svg) ![downloads](https://img.shields.io/npm/dt/elements-zone-strategy.svg)
![license](https://img.shields.io/npm/l/elements-zone-strategy.svg) ![downloads](https://img.shields.io/npm/dt/elements-zone-strategy.svg)

This addresses the following issues with @angular/elements:
* [#23841 - elements: change detection breaks in *ngFor loop](https://github.com/angular/angular/issues/23841)
* [#24181 - @angular/elements component events are called from an inconsistent zone](https://github.com/angular/angular/issues/24181) -- This is fixed in zone.js v0.8.27

- [#23841 - elements: change detection breaks in \*ngFor loop](https://github.com/angular/angular/issues/23841)
- [#24181 - @angular/elements component events are called from an inconsistent zone](https://github.com/angular/angular/issues/24181) -- This is fixed in zone.js v0.8.27

## Usage

install the package:
install the package:

npm install --save elements-zone-strategy

Expand All @@ -22,3 +22,9 @@ use the new strategy:
const strategyFactory = new ElementZoneStrategyFactory(HelloComponent, this.injector);
const helloElement = createCustomElement(HelloComponent, { injector: this.injector, strategyFactory });
customElements.define('my-hello', helloElement);

## Versions

use version 9.0.0 for Angular 9

use version 8.0.0 for Angular 6-8
2 changes: 1 addition & 1 deletion projects/elements-zone-strategy/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "elements-zone-strategy",
"version": "9.0.0-beta.5",
"version": "9.0.0",
"description": "A custom NgElementStrategyFactory to enable zone-based change detection for Angular Elements",
"author": "remackgeek",
"license": "MIT",
Expand Down

0 comments on commit 2bff72d

Please sign in to comment.