fix(tree-list): deprecated due to mobx autorun issues

Deprecated the tree-list component due to issues with Angular 6 and mobx autorun, introduced by angular-tree-component. Fixes #381
patternfly · Jun 15, 2018 · 54810b2 · 54810b2
1 parent 54d234e
commit 54810b2
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/src/app/list/tree-list/tree-list-config.ts b/src/app/list/tree-list/tree-list-config.ts
@@ -2,6 +2,11 @@ import { ListBaseConfig } from '../list-base-config';
 
 /**
  * A config containing properties for tree list
+ *
+ * @deprecated The tree-list component is deprecated due to issues with Angular 6 and mobx autorun,
+ * introduced by angular-tree-component.
+ *
+ * See: https://github.com/patternfly/patternfly-ng/issues/381
  */
 export class TreeListConfig extends ListBaseConfig {
   /**

diff --git a/src/app/list/tree-list/tree-list.component.ts b/src/app/list/tree-list/tree-list.component.ts
@@ -34,6 +34,11 @@ import { TreeListConfig } from './tree-list-config';
  *
  * Or:
  * <br/><code>import { TreeListModule } from 'patternfly-ng';</code>
+ *
+ * @deprecated The tree-list component is deprecated due to issues with Angular 6 and mobx autorun,
+ * introduced by angular-tree-component.
+ *
+ * See: https://github.com/patternfly/patternfly-ng/issues/381
  */
 @Component({
   encapsulation: ViewEncapsulation.None,

diff --git a/src/app/list/tree-list/tree-list.module.ts b/src/app/list/tree-list/tree-list.module.ts
@@ -13,6 +13,11 @@ export {
 
 /**
  * A module containing objects associated with tree list components
+ *
+ * @deprecated The tree-list component is deprecated due to issues with Angular 6 and mobx autorun,
+ * introduced by angular-tree-component.
+ *
+ * See: https://github.com/patternfly/patternfly-ng/issues/381
  */
 @NgModule({
   imports: [
@@ -24,4 +29,9 @@ export {
   declarations: [TreeListComponent],
   exports: [TreeListComponent]
 })
-export class TreeListModule {}
+export class TreeListModule {
+  constructor() {
+    console.log('patternfly-ng: The tree-list component is deprecated due to issues with Angular 6 and ' +
+      'mobx autorun, introduced by angular-tree-component.');
+  }
+}