docs: annotate deprecated and experimental APIs on list page (Reactiv…

…eX#4483)
inf3cti0n95 · Feb 1, 2019 · b74b1c0 · b74b1c0
1 parent 06f1a25
commit b74b1c0
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 4 deletions.
diff --git a/docs_app/src/app/custom-elements/api/api-list.component.html b/docs_app/src/app/custom-elements/api/api-list.component.html
@@ -25,7 +25,10 @@ <h2>{{section.title}}</h2>
     <ul class="api-list">
       <ng-container *ngFor="let item of section.items">
         <li *ngIf="item.show" class="api-item">
-          <a [href]="item.path"><span class="symbol {{item.docType}}"></span> {{item.title}}</a>
+          <a [href]="item.path">
+            <span class="symbol {{item.docType}}"></span>
+            <span class="stability {{item.stability}}">{{item.title}} {{!item.stability || item.stability === 'stable' ? '' : '(' + item.stability + ')'}}</span>
+          </a>
         </li>
       </ng-container>
     </ul>

diff --git a/docs_app/src/app/custom-elements/api/api-list.component.spec.ts b/docs_app/src/app/custom-elements/api/api-list.component.spec.ts
@@ -97,7 +97,7 @@ describe('ApiListComponent', () => {
     });
   });
 
-  describe('initial critera from location', () => {
+  describe('initial criteria from location', () => {
     let locationService: TestLocationService;
 
     beforeEach(() => {
@@ -110,7 +110,7 @@ describe('ApiListComponent', () => {
       component.filteredSections.subscribe(filtered => {
         expect(filtered.length).toBe(1, 'sections');
         expect(filtered[0].name).toBe(section, 'section name');
-        const items = filtered[0].items.filter(item => item.show);
+        const items = filtered[0].items.filter(currentItem => currentItem.show);
         expect(items.length).toBe(1, 'items');
 
         const item = items[0];
@@ -198,6 +198,31 @@ describe('ApiListComponent', () => {
       expect(search.type).toBe('class');
     });
   });
+
+  describe('item stability rendering', () => {
+
+    beforeEach(() => {
+      fixture.detectChanges();
+    });
+
+    function expectRenderedStability(path: string, title: string, classes: string) {
+      const apiListElement: HTMLElement = fixture.nativeElement;
+      const a = apiListElement.querySelector(`a[href="${path}"] ${classes}`) as HTMLElement;
+      expect((a.textContent as string).trim()).toEqual(title.trim());
+    }
+
+    it('should display stable', () => {
+      expectRenderedStability('api/common/class_2', 'Class 2', '.stability');
+    });
+
+    it('should display experimental', () => {
+      expectRenderedStability('api/common/class_1', 'Class 1 (experimental)', '.stability.experimental');
+    });
+
+    it('should display deprecated', () => {
+      expectRenderedStability('api/core/function_1', 'Function 1 (deprecated)', '.stability.deprecated');
+    });
+  });
 });
 
 ////// Helpers ////////
@@ -268,7 +293,7 @@ const apiSections: ApiSection[] = [
       {
         "name": "function_1",
         "title": "Function 1",
-        "path": "api/core/function 1",
+        "path": "api/core/function_1",
         "docType": "function",
         "stability": "deprecated",
         "securityRisk": true

diff --git a/docs_app/src/styles/2-modules/_api-list.scss b/docs_app/src/styles/2-modules/_api-list.scss
@@ -199,6 +199,16 @@ aio-api-list {
         color: $blue-500;
       }
     }
+
+    .stability {
+      &.deprecated {
+        text-decoration: line-through;
+      }
+
+      &.experimental {
+        font-style: italic;
+      }
+    }
   }
 }