ember-tracked-nested

trackedNested objects/arrays are proxied so that any updates to any nested members are notified at the root object which will trigger glimmer's @tracked. The trackedNested object are guaranteed to have the same JSON.stringify output as original object as long as it's just a mixture of POJO, array, and primitives, except for Symbol.

Compatibility

• Ember.js v3.16 or above
• Ember CLI v3.16 or above
• Node.js v10 or above
• Proxy support

Installation

yarn add ember-tracked-nested
# or
npm install ember-tracked-nested
# or
ember install ember-tracked-nested

Usage

import { trackedNested } from '@glimmer/tracking';

class Foo {
    @trackedNested obj = { bar: 2 };
}

or in a component

import Component from '@glimmer/component';
import { trackedNested } from 'ember-tracked-nested';
import { action } from '@ember/object';

// works with POJO
export default class Foo extends Component {
  @trackedNested obj = { bar: 2 };
  
  @action
  changeObj() {
    this.obj.bar = 10;
  }
}

// works when updating nested array
export default class Foo extends Component {
  @trackedNested obj = [{ bar: 2 }, { bar: 4 }];
  
  @action
  changeObj() {
    this.obj[1].bar = 100;
  }
}

// works with array method
export default class Foo extends Component {
  @trackedNested obj = [{ bar: 2 }, { bar: 4 }];

  @action
  changeObj() {
    this.obj.push({ bar: 6 });
  }
}

// works with POJO with getter
export default class Foo extends Component {
  @trackedNested obj = { bar: 2, get foo() { return this.bar } };

  @action
  changeObj() {
    this.obj.bar = 9;
  }
}

or autotracked via args

class SomeObj {
  @trackedNested obj = { a: 1, b: { c: 2 } };
}

// passing nested tracked the MyComponent
<MyComponent @obj={{this.someObjInstance.obj}} />

// sample my-component.hbs, printing out the nested value
{{@obj.a}}

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.