fix: Add JSDoc

apexcharts · Feb 25, 2019 · 4ba3e28 · 4ba3e28
1 parent dc2f28b
commit 4ba3e28
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/src/components.d.ts b/src/components.d.ts
@@ -13,9 +13,15 @@ import '@stencil/core';
 export namespace Components {
 
   interface ApexChart {
+    /**
+    * ApexCharts options
+    */
     'options': object;
   }
   interface ApexChartAttributes extends StencilHTMLAttributes {
+    /**
+    * ApexCharts options
+    */
     'options'?: object;
   }
 }

diff --git a/src/components/apex-chart/apex-chart.tsx b/src/components/apex-chart/apex-chart.tsx
@@ -7,14 +7,21 @@ import ApexCharts from 'apexcharts';
   shadow: false
 })
 export class chart {
-  el: HTMLElement;
+  chartRef: HTMLElement;
+
+  /**
+   * Internal ApexCharts instance
+   */
   @State() chart: ApexCharts = null;
 
+  /**
+   * ApexCharts options
+   */
   @Prop() options: object = {}
 
   componentDidLoad() {
     if (this.chart === null) {
-      this.chart = new ApexCharts(this.el, this.options);
+      this.chart = new ApexCharts(this.chartRef, this.options);
       return this.chart.render();  
     }
   }
@@ -25,6 +32,6 @@ export class chart {
     }
   }
   render() {
-    return <div ref={(el) => this.el = el}></div>;
+    return <div ref={(el) => this.chartRef = el}></div>;
   }
 }