Merge pull request #412 from compodoc/add_examples_tab_to_services

1) Added examples tab to services and hiding of example-url tag on Info tab
compodoc · Dec 18, 2017 · 687b04c · 687b04c
2 parents 3d47d4c + 8293c51
commit 687b04c
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/src/app/compiler/dependencies.interfaces.ts b/src/app/compiler/dependencies.interfaces.ts
@@ -13,6 +13,7 @@ export interface IInjectableDep extends IDep {
     methods: Array<any>;
     description: string;
     sourceCode: string;
+    exampleUrls?;
 
     accessors?: Object;
     constructorObj?: Object;
@@ -25,7 +26,7 @@ export interface IInterceptorDep extends IDep {
     methods: Array<any>;
     description: string;
     sourceCode: string;
-
+    
     accessors?: Object;
     constructorObj?: Object;
     jsdoctags?: Array<string>;

diff --git a/src/app/compiler/dependencies.ts b/src/app/compiler/dependencies.ts
@@ -277,7 +277,8 @@ export class Dependencies {
                                 properties: IO.properties,
                                 methods: IO.methods,
                                 description: IO.description,
-                                sourceCode: srcFile.getText()
+                                sourceCode: srcFile.getText(),
+                                exampleUrls: this.componentHelper.getComponentExampleUrls(srcFile.getText())
                             };
                             if (IO.constructor) {
                                 injectableDeps.constructorObj = IO.constructor;

diff --git a/src/resources/styles/compodoc.css b/src/resources/styles/compodoc.css
@@ -524,6 +524,10 @@ code {
     padding-left: 20px;
 }
 
+example-url {
+    display: none;
+}
+
 i {
     font-style: italic;
 }

diff --git a/src/templates/partials/injectable.hbs b/src/templates/partials/injectable.hbs
@@ -19,6 +19,11 @@
         <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
     </li>
     {{/unless}}
+    {{#if injectable.exampleUrls}}
+    <li>
+        <a href="#example" role="tab" id="example-tab" data-toggle="tab" data-link="example">Examples</a>
+    </li>
+    {{/if}}
 </ul>
 
 <div class="tab-content">
@@ -86,4 +91,14 @@
         <pre class="line-numbers"><code class="language-typescript">{{injectable.sourceCode}}</code></pre>
     </div>
     {{/unless}}
+
+    {{#if injectable.exampleUrls}}
+    <div class="tab-pane fade" id="c-example">
+        {{#each injectable.exampleUrls}}
+            <iframe src="{{this}}" style="height: 100vh; width: 100%;">
+                <p>Your browser does not support iframes.</p>
+            </iframe>
+        {{/each}}
+    </div>
+    {{/if}}
 </div>